kanban-python 0.4.1__tar.gz → 0.5.2__tar.gz

kanban_python-0.5.2/.github/workflows/ci.yml

@@ -0,0 +1,101 @@
+name: Continuous Integration
+
+on:
+  push:
+    # Avoid using all the resources/limits available by checking only
+    # relevant branches and tags. Other branches can be checked via PRs.
+    # branches: [main]
+    tags: ['v[0-9]*', '[0-9]+.[0-9]+*']  # Match tags that resemble a version
+  pull_request:  # Run in every PR
+  workflow_dispatch:  # Allow manually triggering the workflow
+
+permissions:
+  contents: read
+
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        python-version:
+        - "3.9"
+        - "3.13"
+        platform:
+        - ubuntu-latest
+        - macos-latest
+        - windows-latest
+    runs-on: ${{matrix.platform}}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{matrix.python-version}}
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        # For example, using `pytest`
+        run: uv run -p ${{matrix.python-version}} pytest tests
+
+        # Generate Coverage
+      - name: Generate coverage report
+        run: uv run coverage lcov -o coverage.lcov
+      - name: Upload partial coverage report
+        uses: coverallsapp/github-action@v2
+        with:
+          path-to-lcov: coverage.lcov
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: ${{ matrix.platform }} - py${{ matrix.python }}
+          parallel: true
+
+  finalize_coverage:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Finalize coverage report
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true
+
+  publish:
+    needs: finalize_coverage
+    if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags/') }}
+    runs-on: ubuntu-latest
+    environment: 'deploy'
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      # id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: "Build Package"
+        run: uv build
+
+      - name: "Publish Package to PyPi"
+        env:
+          # UV_PUBLISH_USERNAME: __token__
+          UV_PUBLISH_TOKEN: ${{secrets.PYPI_TOKEN}}
+
+        run: uv publish
+      # - name: Publish package distributions to PyPI
+      #   uses: pypa/gh-action-pypi-publish@release/v1

{kanban_python-0.4.1 → kanban_python-0.5.2}/.gitignore

@@ -52,4 +52,3 @@ MANIFEST
 # Per-project virtualenvs
 .venv*/
 .conda*/
-.python-version

kanban_python-0.5.2/.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+        args: ["--maxkb=600"]
+
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.9.1
+  hooks:
+    # Run the linter.
+    - id: ruff
+    # Run the formatter.
+    - id: ruff-format
+
+      #- repo: local
+      #  hooks:
+      #  - id: run tests
+      #    name: Run Tests
+      #    language: system
+      #    entry: pytest
+      #    pass_filenames: false
+      #    always_run: true

kanban_python-0.5.2/.python-version

@@ -0,0 +1 @@
+3.13

{kanban_python-0.4.1 → kanban_python-0.5.2}/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## Version 0.5.2
+- Fix `kanban report` path error if no `-P`-flag provided, with default path
+- Fix `kanban scan` path error if no `-P`-flag provided, with default path
+
+## Version 0.5.1
+- Fix deploymet issue caused by missing version file
+
+## Version 0.5.0
+- Move Project to uv structure and cleanup repository gh-17
+- improve argparser to support new funtionality and give better command overview
+- add `-l`/`--local` flag to `kanban init` command as a shortcut to create a board named `local`, which creates a local board.
+Local boards are stored in the current working directory and not under `user_data_dir`.
+- add `path` argument to `kanban scan` command to declare which path to scan for tasks
+- add `path` argument to `kanban report` command to declare path where the report should be created
+
 ## Version 0.4.1
 - Update minimum python version in ci test
 

{kanban_python-0.4.1 → kanban_python-0.5.2}/PKG-INFO

@@ -1,26 +1,47 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: kanban-python
-Version: 0.4.1
+Version: 0.5.2
 Summary: Terminal Kanban App written in Python
-Home-page: https://github.com/Zaloog/kanban-python
-Author: Zaloog
-Author-email: gramslars@gmail.com
-License: MIT
-Project-URL: Source, https://github.com/Zaloog/kanban-python
-Project-URL: Tracker, https://github.com/Zaloog/kanban-python/issues
-Platform: any
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Repository, https://github.com/Zaloog/kanban-python
+Project-URL: Changelog, https://github.com/Zaloog/kanban-python/blob/main/CHANGELOG.md
+Author-email: Zaloog <gramslars@gmail.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2023 Zaloog
+        
+        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-File: AUTHORS.md
 License-File: LICENSE.txt
-Requires-Dist: importlib-metadata; python_version < "3.8"
-Requires-Dist: rich>=13.7.0
-Requires-Dist: platformdirs<4,>=3
-Provides-Extra: testing
-Requires-Dist: setuptools; extra == "testing"
-Requires-Dist: pytest; extra == "testing"
-Requires-Dist: freezegun; extra == "testing"
-Requires-Dist: pytest-cov; extra == "testing"
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Requires-Dist: platformdirs>=4.3.6
+Requires-Dist: rich>=13.9.4
+Description-Content-Type: text/markdown
 
 <!-- These are examples of badges you might want to add to your README:
      please update the URLs accordingly
@@ -34,9 +55,12 @@ Requires-Dist: pytest-cov; extra == "testing"
 -->
 
 [![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![PyPI-Server](https://img.shields.io/pypi/v/kanban-python.svg)](https://pypi.org/project/kanban-python/)
+[![Pyversions](https://img.shields.io/pypi/pyversions/kanban-python.svg)](https://pypi.python.org/pypi/kanban-python)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Downloads](https://static.pepy.tech/badge/kanban-python)](https://pepy.tech/project/kanban-python)
-[![Coverage Status](https://coveralls.io/repos/github/Zaloog/kanban-python/badge.svg?branch=refs/tags/v0.3.10)](https://coveralls.io/github/Zaloog/kanban-python?branch=refs/tags/v0.3.10)
+[![Coverage Status](https://coveralls.io/repos/github/Zaloog/kanban-python/badge.svg?branch=main)](https://coveralls.io/github/Zaloog/kanban-python?branch=main)
 # kanban-python
 
 > A Terminal Kanban Application written in Python to boost your productivity :rocket:
@@ -51,9 +75,10 @@ my own Terminal Kanban Application since I preferred a more simple and guided wo
 **kanban-python** also comes with more features, like custom column creation,
 automatic scanning and customizable config file to support you being productive.
 
-This package was developed with [pyscaffold], which provides awesome project templates
+This package was initially developed with [pyscaffold], which provides awesome project templates
 and takes over much of the boilerplate for python packaging.
 It was a great help for developing my first package and I can highly recommend it.
+With version `0.5.X` the repository structure was changed to use [uv].
 
 ## Features
 <details><summary>Colorful and Interactive</summary>
@@ -142,10 +167,13 @@ You can install kanban-python with:
 python -m pip install kanban-python
 ```
 
-or using [pipx]:
+or using [pipx] / [uv] / [rye]:
 ```bash
-pipx install kanban-python
+pipx install kanban-python # using pipx
+uv tool install kanban-python # using uv
+rye install kanban-python # using rye
 ```
+I recommend using pipx, rye or uv to install CLI Tools into an isolated environment.
 
 ## Usage
 After Installation of kanban-python, there are 5 commands available:
@@ -158,6 +186,10 @@ Is used to create a new kanban board i.e. it asks for a name and then creates a
 On first use of any command, the `pykanban.ini` configfile and the `kanban-python` folder will be created automatically.
 ![init_file](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_kanban_init.PNG)
 
+You can create local boards in the current working directory by using the name `local` or the flags `-l` or `--local` when
+using `kanban init`. kanban-python checks for local boards and updates the config file accordingly.
+Local boards can only be accessed when using `kanban` in the same folder.
+
 ### Interact with Tasks/Boards
   ```bash
   kanban
@@ -173,7 +205,7 @@ or changing settings, your progress wont be saved.
   ```bash
   kanban scan
   ```
-After executing this command, kanban-python scans your current Directory recursively for the defined filetypes and searches for lines
+After executing this command, kanban-python scans your current directory recursively for the defined filetypes and searches for lines
 that start with the pattern provided.
 ![scan_view](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_scan_view.PNG)
 
@@ -181,6 +213,8 @@ After confirmation to add the found tasks to table they will be added to the boa
 The filepath were the task was found will be added as description of the task.
 ![scan_table](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_scan_table.PNG)
 
+You can also define a different path to scan with the `-p` or `--path` argument.
+
 ### Create Report
   ```bash
   kanban report
@@ -189,13 +223,15 @@ Goes over all your Boards and creates a single markdown file by checking the `Co
 Also shows a nice github-like contribution table for the current year.
 ![report](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_kanban_report.PNG)
 
+You can define a different output path of the `pykanban.md` report file with the `-p` or `--path` argument.
+
 ### Change Settings
   ```bash
   kanban configure
   ```
 ![settings](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_kanban_configure.PNG)
 
-To create a new custom Columns, you have to edit the `pykanban.ini` manually and add a new column name + visibility status
+To create a new custom Column, you have to edit the `pykanban.ini` manually and add a new column name + visibility status
 under the `settings.columns.visible` section. The other options are all customizable now via the new settings menu.
 
 
@@ -207,12 +243,7 @@ Also check the [Changelog](https://github.com/Zaloog/kanban-python/blob/main/CHA
 With release v0.3.0 kanban-python switched to the [XDG] Basedir Spec. So some file migrations and config edits might be
 needed to continue working with your already created boards if you update from `v0.2.X` to `v0.3.X`
 
-<!-- pyscaffold-notes -->
-
-## Note
 
-This project has been set up using PyScaffold 4.5. For details and usage
-information on PyScaffold see https://pyscaffold.org/.
 
 [XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
 [platformdirs]: https://platformdirs.readthedocs.io/en/latest/
@@ -220,3 +251,5 @@ information on PyScaffold see https://pyscaffold.org/.
 [pyscaffold]: https://pyscaffold.org/
 [rich]: https://github.com/Textualize/rich
 [pipx]: https://github.com/pypa/pipx
+[uv]: https://docs.astral.sh/uv/
+[rye]: https://rye.astral.sh

kanban_python-0.4.1/src/kanban_python.egg-info/PKG-INFO → kanban_python-0.5.2/README.md

@@ -1,27 +1,3 @@
-Metadata-Version: 2.1
-Name: kanban-python
-Version: 0.4.1
-Summary: Terminal Kanban App written in Python
-Home-page: https://github.com/Zaloog/kanban-python
-Author: Zaloog
-Author-email: gramslars@gmail.com
-License: MIT
-Project-URL: Source, https://github.com/Zaloog/kanban-python
-Project-URL: Tracker, https://github.com/Zaloog/kanban-python/issues
-Platform: any
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-License-File: LICENSE.txt
-Requires-Dist: importlib-metadata; python_version < "3.8"
-Requires-Dist: rich>=13.7.0
-Requires-Dist: platformdirs<4,>=3
-Provides-Extra: testing
-Requires-Dist: setuptools; extra == "testing"
-Requires-Dist: pytest; extra == "testing"
-Requires-Dist: freezegun; extra == "testing"
-Requires-Dist: pytest-cov; extra == "testing"
-
 <!-- These are examples of badges you might want to add to your README:
      please update the URLs accordingly
 
@@ -34,9 +10,12 @@ Requires-Dist: pytest-cov; extra == "testing"
 -->
 
 [![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![PyPI-Server](https://img.shields.io/pypi/v/kanban-python.svg)](https://pypi.org/project/kanban-python/)
+[![Pyversions](https://img.shields.io/pypi/pyversions/kanban-python.svg)](https://pypi.python.org/pypi/kanban-python)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Downloads](https://static.pepy.tech/badge/kanban-python)](https://pepy.tech/project/kanban-python)
-[![Coverage Status](https://coveralls.io/repos/github/Zaloog/kanban-python/badge.svg?branch=refs/tags/v0.3.10)](https://coveralls.io/github/Zaloog/kanban-python?branch=refs/tags/v0.3.10)
+[![Coverage Status](https://coveralls.io/repos/github/Zaloog/kanban-python/badge.svg?branch=main)](https://coveralls.io/github/Zaloog/kanban-python?branch=main)
 # kanban-python
 
 > A Terminal Kanban Application written in Python to boost your productivity :rocket:
@@ -51,9 +30,10 @@ my own Terminal Kanban Application since I preferred a more simple and guided wo
 **kanban-python** also comes with more features, like custom column creation,
 automatic scanning and customizable config file to support you being productive.
 
-This package was developed with [pyscaffold], which provides awesome project templates
+This package was initially developed with [pyscaffold], which provides awesome project templates
 and takes over much of the boilerplate for python packaging.
 It was a great help for developing my first package and I can highly recommend it.
+With version `0.5.X` the repository structure was changed to use [uv].
 
 ## Features
 <details><summary>Colorful and Interactive</summary>
@@ -142,10 +122,13 @@ You can install kanban-python with:
 python -m pip install kanban-python
 ```
 
-or using [pipx]:
+or using [pipx] / [uv] / [rye]:
 ```bash
-pipx install kanban-python
+pipx install kanban-python # using pipx
+uv tool install kanban-python # using uv
+rye install kanban-python # using rye
 ```
+I recommend using pipx, rye or uv to install CLI Tools into an isolated environment.
 
 ## Usage
 After Installation of kanban-python, there are 5 commands available:
@@ -158,6 +141,10 @@ Is used to create a new kanban board i.e. it asks for a name and then creates a
 On first use of any command, the `pykanban.ini` configfile and the `kanban-python` folder will be created automatically.
 ![init_file](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_kanban_init.PNG)
 
+You can create local boards in the current working directory by using the name `local` or the flags `-l` or `--local` when
+using `kanban init`. kanban-python checks for local boards and updates the config file accordingly.
+Local boards can only be accessed when using `kanban` in the same folder.
+
 ### Interact with Tasks/Boards
   ```bash
   kanban
@@ -173,7 +160,7 @@ or changing settings, your progress wont be saved.
   ```bash
   kanban scan
   ```
-After executing this command, kanban-python scans your current Directory recursively for the defined filetypes and searches for lines
+After executing this command, kanban-python scans your current directory recursively for the defined filetypes and searches for lines
 that start with the pattern provided.
 ![scan_view](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_scan_view.PNG)
 
@@ -181,6 +168,8 @@ After confirmation to add the found tasks to table they will be added to the boa
 The filepath were the task was found will be added as description of the task.
 ![scan_table](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_scan_table.PNG)
 
+You can also define a different path to scan with the `-p` or `--path` argument.
+
 ### Create Report
   ```bash
   kanban report
@@ -189,13 +178,15 @@ Goes over all your Boards and creates a single markdown file by checking the `Co
 Also shows a nice github-like contribution table for the current year.
 ![report](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_kanban_report.PNG)
 
+You can define a different output path of the `pykanban.md` report file with the `-p` or `--path` argument.
+
 ### Change Settings
   ```bash
   kanban configure
   ```
 ![settings](https://raw.githubusercontent.com/Zaloog/kanban-python/main/images/image_kanban_configure.PNG)
 
-To create a new custom Columns, you have to edit the `pykanban.ini` manually and add a new column name + visibility status
+To create a new custom Column, you have to edit the `pykanban.ini` manually and add a new column name + visibility status
 under the `settings.columns.visible` section. The other options are all customizable now via the new settings menu.
 
 
@@ -207,12 +198,7 @@ Also check the [Changelog](https://github.com/Zaloog/kanban-python/blob/main/CHA
 With release v0.3.0 kanban-python switched to the [XDG] Basedir Spec. So some file migrations and config edits might be
 needed to continue working with your already created boards if you update from `v0.2.X` to `v0.3.X`
 
-<!-- pyscaffold-notes -->
-
-## Note
 
-This project has been set up using PyScaffold 4.5. For details and usage
-information on PyScaffold see https://pyscaffold.org/.
 
 [XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
 [platformdirs]: https://platformdirs.readthedocs.io/en/latest/
@@ -220,3 +206,5 @@ information on PyScaffold see https://pyscaffold.org/.
 [pyscaffold]: https://pyscaffold.org/
 [rich]: https://github.com/Textualize/rich
 [pipx]: https://github.com/pypa/pipx
+[uv]: https://docs.astral.sh/uv/
+[rye]: https://rye.astral.sh

kanban_python-0.5.2/pyproject.toml

@@ -0,0 +1,56 @@
+[project]
+name = "kanban-python"
+version = "0.5.2"
+description = "Terminal Kanban App written in Python"
+readme = "README.md"
+authors = [
+    { name = "Zaloog", email = "gramslars@gmail.com" }
+]
+requires-python = ">=3.9"
+license = { file = "LICENSE.txt" }
+dependencies = [
+    "platformdirs>=4.3.6",
+    "rich>=13.9.4",
+]
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3 :: Only",
+]
+
+[project.urls]
+Repository = "https://github.com/Zaloog/kanban-python"
+Changelog = "https://github.com/Zaloog/kanban-python/blob/main/CHANGELOG.md"
+
+[project.scripts]
+kanban = "kanban_python.app:run"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+addopts = "--cov src/kanban_python --cov-report term-missing --verbose --color=yes"
+testpaths = ["tests"]
+
+[tool.uv]
+dev-dependencies = [
+    "freezegun>=1.5.1",
+    "pre-commit>=4.0.1",
+    "pytest>=8.3.3",
+    "pytest-cov>=6.0.0",
+]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/kanban_python"]

kanban_python-0.5.2/src/kanban_python/app.py

@@ -0,0 +1,69 @@
+import sys
+from pathlib import Path
+
+from kanban_python import cli_parser, config, controls, utils, constants
+
+__author__ = "Zaloog"
+__copyright__ = "Zaloog"
+__license__ = "MIT"
+
+
+def main(args):
+    args = cli_parser.parse_args(args)
+
+    if not config.check_config_exists():
+        config.create_init_config()
+        return
+
+    # Delete Local Entry if no local file present
+    if (not Path("pykanban.json").exists()) and ("local" in config.cfg.kanban_boards):
+        config.delete_board_from_config(board_name="local")
+
+    # New database creation
+    if args.command == "init":
+        utils.console.print("Starting new [blue]Kanban Board[/]:mechanical_arm:")
+        controls.create_new_db(local=args.local)
+
+    if args.command == "configure":
+        controls.change_settings()
+
+    if args.command == "scan":
+        controls.add_todos_to_board(path=Path(args.path) or Path.cwd())
+
+    if args.command == "report":
+        controls.create_report(
+            output_path=Path(args.path) or constants.REPORT_FILE_PATH
+        )
+        return
+
+    while True:
+        controls.show()
+        user_input = controls.get_user_action()
+
+        if user_input == 1:
+            controls.add_new_task_to_db()
+        elif user_input == 2:
+            controls.update_task_from_db()
+        elif user_input == 3:
+            controls.change_kanban_board()
+        elif user_input == 4:
+            controls.show_tasks()
+        elif user_input == 5:
+            controls.delete_kanban_board()
+        elif user_input == 6:
+            controls.change_settings()
+
+
+def run():
+    """Calls :func:`main` passing the CLI arguments extracted from :obj:`sys.argv`
+
+    This function can be used as entry point to create console scripts with setuptools.
+    """
+    try:
+        main(sys.argv[1:])
+    except (KeyboardInterrupt, EOFError):
+        utils.console.print(utils.get_motivational_quote())
+
+
+if __name__ == "__main__":
+    run()

kanban_python-0.5.2/src/kanban_python/cli_parser.py

@@ -0,0 +1,64 @@
+import argparse
+
+from kanban_python import __version__
+from kanban_python.constants import REPORT_FILE_PATH
+
+
+def parse_args(args):
+    """Parse command line parameters
+
+    Args:
+      args (List[str]): command line parameters as list of strings
+          (for example  ``["--help"]``).
+
+    Returns:
+      :obj:`argparse.Namespace`: command line parameters namespace
+    """
+    parser = argparse.ArgumentParser(description="Usage Options")
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=f"kanban-python {__version__}",
+    )
+
+    command_parser = parser.add_subparsers(
+        title="commands", dest="command", description="available commands"
+    )
+
+    # Init
+    init_parser = command_parser.add_parser(
+        "init",
+        help="initialize a new board, use `--local`-flag to create in current working directory",
+    )
+    init_parser.add_argument(
+        "-l",
+        "--local",
+        help="create a local board in the current working directory, default:False",
+        action="store_true",
+    )
+
+    # Configure
+    command_parser.add_parser("configure", help="configure settings")
+
+    # Scan
+    scan_parser = command_parser.add_parser(
+        "scan", help="scan path for TODOs in files (default: `.`)"
+    )
+    scan_parser.add_argument(
+        "-p", "--path", required=False, help="path to scan (default: `.`)", default="."
+    )
+
+    # Report
+    report_parser = command_parser.add_parser(
+        "report", help=f"create report in output path (default: {REPORT_FILE_PATH})"
+    )
+    report_parser.add_argument(
+        "-p",
+        "--path",
+        required=False,
+        help=f"path to save output to (default: {REPORT_FILE_PATH})",
+        default=REPORT_FILE_PATH,
+    )
+
+    return parser.parse_args(args)

{kanban_python-0.4.1 → kanban_python-0.5.2}/src/kanban_python/config.py

@@ -189,4 +189,6 @@ def check_config_exists(path=CONFIG_FILE_PATH) -> bool:
 
 
 def get_json_path(boardname: str):
-    return str(KANBAN_BOARDS_PATH / boardname / TASK_FILE_NAME)
+    if boardname == "local":
+        return (Path().cwd() / TASK_FILE_NAME).as_posix()
+    return (KANBAN_BOARDS_PATH / boardname / TASK_FILE_NAME).as_posix()