update

Author: ax-va

.coverage

@@ -0,0 +1,4 @@
+[paths]
+source =
+    src
+    .tox/*/lib/python*/site-packages

.coveragerc

@@ -0,0 +1,31 @@
+name: tox-pytest-Okken-2022
+
+# Run tests every time either code is pushed to the repository or a pull request is created
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    # Specify which operating system to run the tests on
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # Specify which Python versions to run
+        python: ["3.10", "3.11", "3.12"]
+
+    steps:
+      # Check out the repository by using the `actions/checkout@v2` GitHub tool
+      # so the rest of the workflow can access it
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        # Get Python configured and installed in a build environment by using the `setup-python@v2` GitHub tool
+        uses: actions/setup-python@v2
+        with:
+          # Create an environment for each of the Python versions listed in matrix: python
+          python-version: ${{ matrix.python }}
+      - name: Install Tox and any other packages
+        # Install tox
+        run: pip install tox
+      - name: Run Tox
+        # Run tox selecting the correct version of Python specified in `tox.ini`
+        run: tox -e py -c tox_github_actions.ini

.github/workflows/main.yml

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018, Brian Okken
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -1 +1 @@
-# GitHub-Actions-tox-pytest
+...

README.md

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "cards"
+authors = [{name = "Brian Okken", email = "brian+pypi@pythontest.com"}]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+]
+requires-python=">=3.7"
+dynamic = ["version", "description"]
+dependencies = [
+    "tinydb==4.5.1",
+    "typer==0.3.2",
+    "rich==10.7.0"
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "faker",
+    "tox",
+    "coverage",
+    "pytest-cov",
+]
+
+[project.urls]
+Home = "https://github.com/okken/cards"
+
+[project.scripts]
+cards = "cards:app"
+

pyproject.toml

@@ -0,0 +1,18 @@
+;---
+; Excerpted from "Python Testing with pytest, Second Edition",
+; published by The Pragmatic Bookshelf.
+; Copyrights apply to this code. It may not be used to create training material,
+; courses, books, articles, and the like. Contact us if you are in doubt.
+; We make no guarantees that this code is fit for any purpose.
+; Visit https://pragprog.com/titles/bopytest2 for more book information.
+;---
+[pytest]
+addopts =
+    --strict-markers
+    --strict-config
+    -ra
+
+markers =
+    num_cards: number of cards to prefill for cards_db fixture
+
+testpaths = tests

pytest.ini

@@ -0,0 +1,6 @@
+"""Top-level package for cards."""
+
+__version__ = "1.0.0"
+
+from .api import *  # noqa
+from .cli import app  # noqa

src/cards/__init__.py

@@ -0,0 +1,125 @@
+"""
+API for the cards project
+"""
+from dataclasses import asdict
+from dataclasses import dataclass
+from dataclasses import field
+from typing import List
+import cards
+
+from .db import DB
+
+__all__ = [
+    "Card",
+    "CardsDB",
+    "CardsException",
+    "MissingSummary",
+    "InvalidCardId",
+]
+
+
+@dataclass
+class Card:
+    summary: str = None
+    owner: str = None
+    state: str = "todo"
+    id: int = field(default=None, compare=False)
+
+    @classmethod
+    def from_dict(cls, d):
+        return Card(**d)
+
+    def to_dict(self):
+        return asdict(self)
+
+
+class CardsException(Exception):
+    pass
+
+
+class MissingSummary(CardsException):
+    pass
+
+
+class InvalidCardId(CardsException):
+    pass
+
+
+class CardsDB:
+    def __init__(self, db_path):
+        self._db_path = db_path
+        self._db = DB(db_path, ".cards_db")
+
+    def add_card(self, card: Card) -> int:
+        """Add a card, return the id of card."""
+        if not card.summary:
+            raise MissingSummary
+        if card.owner is None:
+            card.owner = ""
+        id = self._db.create(card.to_dict())
+        self._db.update(id, {"id": id})
+        return id
+
+    def get_card(self, card_id: int) -> Card:
+        """Return a card with a matching id."""
+        db_item = self._db.read(card_id)
+        if db_item is not None:
+            return Card.from_dict(db_item)
+        else:
+            raise InvalidCardId(card_id)
+
+    def list_cards(self, owner=None, state=None):
+        """Return a list of cards."""
+        all = self._db.read_all()
+        if (owner is not None) and (state is not None):
+            return [
+                Card.from_dict(t)
+                for t in all
+                if (t["owner"] == owner and t["state"] == state)
+            ]
+        elif owner is not None:
+            return [
+                Card.from_dict(t) for t in all if t["owner"] == owner
+            ]
+        elif state is not None:
+            return [
+                Card.from_dict(t) for t in all if t["state"] == state
+            ]
+        else:
+            return [Card.from_dict(t) for t in all]
+
+    def count(self) -> int:
+        """Return the number of cards in db."""
+        return self._db.count()
+
+    def update_card(self, card_id: int, card_mods: Card) -> None:
+        """Update a card with modifications."""
+        try:
+            self._db.update(card_id, card_mods.to_dict())
+        except KeyError as exc:
+            raise InvalidCardId(card_id) from exc
+
+    def start(self, card_id: int):
+        """Set a card state to 'in prog'."""
+        self.update_card(card_id, Card(state="in prog"))
+
+    def finish(self, card_id: int):
+        """Set a card state to 'done'."""
+        self.update_card(card_id, Card(state="done"))
+
+    def delete_card(self, card_id: int) -> None:
+        """Remove a card from db with given card_id."""
+        try:
+            self._db.delete(card_id)
+        except KeyError as exc:
+            raise InvalidCardId(card_id) from exc
+
+    def delete_all(self) -> None:
+        """Remove all cards from db."""
+        self._db.delete_all()
+
+    def close(self):
+        self._db.close()
+
+    def path(self):
+        return self._db_path

src/cards/api.py

@@ -0,0 +1,139 @@
+"""Command Line Interface (CLI) for cards project."""
+import os
+from io import StringIO
+import pathlib
+import rich
+from rich.table import Table
+from contextlib import contextmanager
+from typing import List
+
+import cards
+
+import typer
+
+app = typer.Typer(add_completion=False)
+
+@app.command()
+def version():
+    """Return version of cards application"""
+    print(cards.__version__)
+
+
+@app.command()
+def add(
+    summary: List[str], owner: str = typer.Option(None, "-o", "--owner")
+):
+    """Add a card to db."""
+    summary = " ".join(summary) if summary else None
+    with cards_db() as db:
+        db.add_card(cards.Card(summary, owner, state="todo"))
+
+
+@app.command()
+def delete(card_id: int):
+    """Remove card in db with given id."""
+    with cards_db() as db:
+        try:
+            db.delete_card(card_id)
+        except cards.InvalidCardId:
+            print(f"Error: Invalid card id {card_id}")
+
+
+@app.command("list")
+def list_cards(
+    owner: str = typer.Option(None, "-o", "--owner"),
+    state: str = typer.Option(None, "-s", "--state"),
+):
+    """
+    List cards in db.
+    """
+    with cards_db() as db:
+        the_cards = db.list_cards(owner=owner, state=state)
+        table = Table(box=rich.box.SIMPLE)
+        table.add_column("ID")
+        table.add_column("state")
+        table.add_column("owner")
+        table.add_column("summary")
+        for t in the_cards:
+            owner = "" if t.owner is None else t.owner
+            table.add_row(str(t.id), t.state, owner, t.summary)
+        out = StringIO()
+        rich.print(table, file=out)
+        print(out.getvalue())
+
+
+@app.command()
+def update(
+    card_id: int,
+    owner: str = typer.Option(None, "-o", "--owner"),
+    summary: List[str] = typer.Option(None, "-s", "--summary"),
+):
+    """Modify a card in db with given id with new info."""
+    summary = " ".join(summary) if summary else None
+    with cards_db() as db:
+        try:
+            db.update_card(
+                card_id, cards.Card(summary, owner, state=None)
+            )
+        except cards.InvalidCardId:
+            print(f"Error: Invalid card id {card_id}")
+
+
+@app.command()
+def start(card_id: int):
+    """Set a card state to 'in prog'."""
+    with cards_db() as db:
+        try:
+            db.start(card_id)
+        except cards.InvalidCardId:
+            print(f"Error: Invalid card id {card_id}")
+
+
+@app.command()
+def finish(card_id: int):
+    """Set a card state to 'done'."""
+    with cards_db() as db:
+        try:
+            db.finish(card_id)
+        except cards.InvalidCardId:
+            print(f"Error: Invalid card id {card_id}")
+
+
+@app.command()
+def config():
+    """List the path to the Cards db."""
+    with cards_db() as db:
+        print(db.path())
+
+
+@app.command()
+def count():
+    """Return number of cards in db."""
+    with cards_db() as db:
+        print(db.count())
+
+
+@app.callback(invoke_without_command=True)
+def main(ctx: typer.Context):
+    """
+    Cards is a small command line task tracking application.
+    """
+    if ctx.invoked_subcommand is None:
+        list_cards(owner=None, state=None)
+
+
+def get_path():
+    db_path_env = os.getenv("CARDS_DB_DIR", "")
+    if db_path_env:
+        db_path = pathlib.Path(db_path_env)
+    else:
+        db_path = pathlib.Path.home() / "cards_db"
+    return db_path
+
+
+@contextmanager
+def cards_db():
+    db_path = get_path()
+    db = cards.CardsDB(db_path)
+    yield db
+    db.close()