reclaim-cli 0.1.1__tar.gz

reclaim_cli-0.1.1/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1] - 2025-04-26
+
+### Added
+
+- Initial release of Reclaim CLI
+- Basic task management commands (create, list, show, edit, delete)
+- Time tracking functionality
+- Configuration management
+- Command-line interface with help formatting
+
+### Changed
+
+- Fixed issues with double parsing of durations
+- Renamed location of patched reclaim-sdk on Github

reclaim_cli-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Konrad Rieck (<konrad@mlsec.org>)
+
+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. 

reclaim_cli-0.1.1/MANIFEST.in

@@ -0,0 +1,24 @@
+include LICENSE
+include README.md
+include CHANGELOG.md
+include pyproject.toml
+
+recursive-include tests *
+
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude *.so
+global-exclude *.egg-info
+
+global-exclude build/
+global-exclude dist/
+
+global-exclude .git
+global-exclude .gitignore
+global-exclude .coverage
+global-exclude .pytest_cache
+global-exclude .mypy_cache
+global-exclude .ruff_cache
+global-exclude .DS_Store
+global-exclude .idea/
+global-exclude .vscode/ 

reclaim_cli-0.1.1/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.4
+Name: reclaim-cli
+Version: 0.1.1
+Summary: CLI for Reclaim.ai service
+License: MIT
+Requires-Python: >=3.8
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: dateparser==1.2.1
+Requires-Dist: rich==13.9.4
+Requires-Dist: reclaim-sdk-fixed==0.6.3.post1
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: flake8-docstrings; extra == "dev"
+Requires-Dist: flake8-bugbear; extra == "dev"
+Requires-Dist: flake8-quotes; extra == "dev"
+Dynamic: license-file

reclaim_cli-0.1.1/README.md

@@ -0,0 +1,98 @@
+# Reclaim CLI
+
+Copyright (c) 2025 Konrad Rieck (<konrad@mlsec.org>)
+
+## About
+
+This is a simple Python CLI for the Reclaim service.
+
+## Usage
+
+The `reclaim` tool provides a simple and flexible command-line interface (CLI) for managing tasks at [Reclaim.ai](https://reclaim.ai). At its core, `reclaim` operates through a set of commands, each targeting a specific aspect of task management. The commands allow you to create tasks, log work, lists tasks, start and stop time tracking, and more.
+
+To see the available commands, you can run:
+
+```console
+reclaim --help
+usage: reclaim [options] <command> ...
+
+Reclaim CLI
+
+positional arguments:
+    add-time (add)                      add time to a task
+    create-task (create)                create a task
+    delete-task (delete)                delete a task
+    list-tasks (list)                   list tasks
+    log-work (log)                      log work to a task
+    mark-task (mark)                    mark a task (in)complete
+    show-task (show)                    show a task
+    start-task (start)                  start a task
+    stop-task (stop)                    stop a task
+
+options:
+  -h, --help                            show this help message and exit
+  -c <file>, --config <file>            set config file (default: ~/.reclaim)
+```
+
+Each command follows a consistent pattern and can be extended with its own options. Simply run `reclaim <command> --help`.
+
+## Example
+
+Here is a simple example illustrating how to use the tool. Suppose you want to create a task for writing a new blog post with a duration of 8 hours and a due date in 20 days. You would run:
+
+```sh
+reclaim create-task "Write new blog post" --duration 8h -due "in 10 days" 
+# ✓ Created | Id: 5g5p4 | Title: Write new blog post
+```
+
+The output of the tool is shown as comment in the example. You can then list your tasks like this:
+
+```sh
+reclaim list-tasks
+# Id     Due          Left  Prog  State  Title                  
+# 5g5p4  2025-04-13   8h0m    0%   N3    Write new blog post
+```
+
+You task has state `N` (new) with default priority 3. Later, you realize that you need less time for the task. Simply update it using its identifier:
+
+```sh
+reclaim edit-task 5g5p4 --duration 4h
+# ✓ Edited | Id: 5g5p4 | Title: Write new blog post
+```
+
+Eventually, you notice that nobody reads blogs anymore, so you delete the task and move on:
+
+```sh
+reclaim delete-task 5g5p4
+# ✓ Deleted | Id: 5g5p4 | Title: Write new blog post
+```
+
+## Installation
+
+The tool is easiest installed directly from Github. You can run
+
+```sh
+pip install git+https://github.com/rieck/reclaim-cli.git
+```
+
+This will install the latest version of the tool directly from the repository. You can also install it in development mode by cloning the repository and running:
+
+```sh
+git clone https://github.com/rieck/reclaim-cli.git
+cd reclaim-cli
+pip install -e ".[dev]"
+```
+
+After installation, the `reclaim` command will be available in your terminal. If you want to work on the tool, you can use the following tools to streamline your implementation.
+
+```sh
+pre-commit install
+black src/
+isort src/
+flake8 src/
+pytest
+```
+
+## Dependencies
+
+The tool relies on the [unofficial Reclaim.ai Python SDK](https://github.com/labiso-gmbh/reclaim-sdk) developed by Labiso GmbH. However, since it requires functionality beyond what is available in version `v0.6.3` of the SDK, the dependency is installed from a [patched fork](https://github.com/rieck/reclaim-sdk/tree/fixed).

reclaim_cli-0.1.1/TODO.md

@@ -0,0 +1,14 @@
+# TODOs
+
+- [X] Create separate parsing for dates and times
+- [X] Consider option to align printing functions
+- [X] Support relative dates to "now", e.g. "in 2 days"
+- [X] Implement `show` command to show all about a task
+- [X] Implement `edit` command to change a task
+- [X] Check out `rich` package for display functions
+- [x] Implement some test cases
+- [x] Improve packaging and maintance scripts
+- [ ] Implement load estimation (this week, next week, ...)
+- [ ] Detect incorrect dates
+- [ ] Fix timezone madness when testing on Github
+- [ ] Fix problem with snooze_until int vs. str

reclaim_cli-0.1.1/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["setuptools>=45", "packaging>=24.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "reclaim-cli"
+version = "0.1.1"
+description = "CLI for Reclaim.ai service"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+dependencies = [
+    "PyYAML>=6.0",
+    "dateparser==1.2.1",
+    "rich==13.9.4",
+    "reclaim-sdk-fixed==0.6.3.post1",
+]
+
+[project.scripts]
+reclaim = "reclaim.__main__:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+packages = ["reclaim", "reclaim.commands"]
+
+# Testing configuration
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --cov=reclaim"
+filterwarnings = [
+    "ignore::DeprecationWarning:pydantic.*"
+]
+
+# Type checking
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+# Code formatting
+[tool.black]
+line-length = 79
+target-version = ['py38']
+include = '\.pyi?$'
+
+# Import sorting
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-cov",
+    "black",
+    "isort",
+    "pre-commit",
+    "flake8",
+    "flake8-docstrings",
+    "flake8-bugbear",
+    "flake8-quotes",    
+]

reclaim_cli-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

reclaim_cli-0.1.1/src/reclaim/__init__.py

@@ -0,0 +1,6 @@
+"""Reclaim CLI Tool.
+
+Copyright (c) 2025 Konrad Rieck <konrad@mlsec.org>
+"""
+
+__version__ = "0.1.0"

reclaim_cli-0.1.1/src/reclaim/__main__.py

@@ -0,0 +1,74 @@
+"""Reclaim CLI Main.
+
+Copyright (c) 2025 Konrad Rieck <konrad@mlsec.org>
+"""
+
+import argparse
+import os
+import sys
+
+import reclaim.commands as commands
+from reclaim.utils import HelpFormatter, load_config, set_api_key
+
+
+def parse_args(cmds):
+    """Parse command line arguments."""
+    parser = argparse.ArgumentParser(
+        prog="reclaim",
+        description="Reclaim CLI",
+        formatter_class=HelpFormatter,
+    )
+
+    # Global options
+    parser.add_argument(
+        "-c",
+        "--config",
+        type=str,
+        metavar="<file>",
+        default="~/.reclaim",
+        help="set config file",
+    )
+
+    # Create subparsers
+    subparsers = parser.add_subparsers(dest="command", required=True)
+    for cmd in cmds:
+        cmd.parse_args(subparsers)
+
+    # Parse global args
+    args = parser.parse_args()
+
+    # Expand user home directory
+    args.config = os.path.expanduser(args.config)
+
+    # Validate arguments
+    for cmd in cmds:
+        if args.command == cmd.name or args.command in cmd.aliases:
+            cmd.validate_args(args)
+
+    return args
+
+
+def format_exception(error):
+    """Format an error message."""
+    return f"Error: {str(error)}"
+
+
+def main():
+    """Run the Reclaim CLI."""
+    try:
+        cmds = commands.load()
+        args = parse_args(cmds)
+        args = load_config(args)
+        set_api_key(args)
+        args.func(args)
+
+    except Exception as e:
+        print(format_exception(e), file=sys.stderr)
+        import traceback
+
+        traceback.print_exc()
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

reclaim_cli-0.1.1/src/reclaim/commands/__init__.py

@@ -0,0 +1,33 @@
+"""Load and initialize the commands.
+
+Copyright (c) 2025 Konrad Rieck <konrad@mlsec.org>
+"""
+
+import glob
+import os
+
+from .base import Command
+
+
+def load():
+    """Find all files in the command directory and import them."""
+    cmd_dir = os.path.relpath(os.path.dirname(__file__))
+
+    # get cmd files
+    cmd_files = [
+        filename
+        for filename in glob.glob("%s/*.py" % cmd_dir)
+        if not filename.endswith("__init__.py")
+    ]
+
+    # import all cmds (except base cmd)
+    for cmd_file in cmd_files:
+        module_name = os.path.splitext(cmd_file)[0]
+        module_name = module_name[module_name.find("reclaim/commands") :]
+        module_name = module_name.replace("/", ".")
+        if not module_name.endswith("base"):
+            __import__(module_name)
+
+    cmds = Command.__subclasses__()
+    cmds = [c() for c in cmds]  # Initialize the commands
+    return sorted(cmds, key=lambda x: x.name)

reclaim_cli-0.1.1/src/reclaim/commands/add-time.py

@@ -0,0 +1,39 @@
+"""Command to add time to a task at Reclaim.ai.
+
+Copyright (c) 2025 Konrad Rieck <konrad@mlsec.org>
+"""
+
+from ..utils import get_task, print_done, str_duration
+from .base import Command
+
+
+class AddTimeCommand(Command):
+    """Add time to task at Reclaim.ai."""
+
+    name = "add-time"
+    description = "add time to a task"
+    aliases = ["add"]
+
+    def parse_args(self, subparsers):
+        """Add arguments to the subparser."""
+        subparser = super().parse_args(subparsers)
+
+        subparser.add_argument(
+            "id", type=str, metavar="<id>", help="task id to add time to"
+        )
+        subparser.add_argument(
+            "duration", type=str, metavar="<duration>", help="duration to add"
+        )
+
+        return subparser
+
+    def run(self, args):
+        """Add time to task at Reclaim.ai."""
+        task = get_task(args.id)
+
+        # Add time to task
+        task.add_time(args.duration / 60)  # Expects hours
+        dur = str_duration(args.duration)
+        print_done(f"Added: {dur}", task)
+
+        return task

reclaim_cli-0.1.1/src/reclaim/commands/base.py

@@ -0,0 +1,57 @@
+"""Base class for CLI commands.
+
+Copyright (c) 2025 Konrad Rieck <konrad@mlsec.org>
+"""
+
+from ..utils import (
+    HelpFormatter,
+    parse_datetime,
+    parse_duration,
+    parse_priority,
+    str_to_id,
+)
+
+
+class Command(object):
+    """Abstract base class for CLI commands."""
+
+    name = None  # Command name
+    description = None  # Command description
+    aliases = []  # Command aliases
+
+    def parse_args(self, subparsers):
+        """Add arguments to the subparser."""
+        subparser = subparsers.add_parser(
+            self.name,
+            help=self.description,
+            aliases=self.aliases,
+            formatter_class=HelpFormatter,
+        )
+        subparser.set_defaults(func=self.run)
+        return subparser
+
+    def run(self, args):
+        """Execute the command."""
+        pass
+
+    def validate_args(self, args):
+        """Validate and transform command arguments."""
+        check_args = {
+            "id": str_to_id,
+            "snooze_until": parse_datetime,
+            "due": parse_datetime,
+            "log_time": parse_datetime,
+            "priority": parse_priority,
+            "duration": parse_duration,
+            "min_chunk_size": parse_duration,
+            "max_chunk_size": parse_duration,
+        }
+
+        for name, validate in check_args.items():
+            if hasattr(args, name) and getattr(args, name) is not None:
+                try:
+                    setattr(args, name, validate(getattr(args, name)))
+                except ValueError as e:
+                    raise ValueError(f"Invalid {name}: {str(e)}")
+
+        return args

reclaim_cli-0.1.1/src/reclaim/commands/create-task.py

@@ -0,0 +1,111 @@
+"""Command to create a task at Reclaim.ai.
+
+Copyright (c) 2025 Konrad Rieck <konrad@mlsec.org>
+"""
+
+from reclaim_sdk.resources.task import Task
+
+from ..utils import print_done
+from .base import Command
+
+
+class CreateTaskCommand(Command):
+    """Create a task at Reclaim.ai."""
+
+    name = "create-task"
+    description = "create a task"
+    aliases = ["create"]
+
+    def parse_args(self, subparsers):
+        """Add arguments to the subparser."""
+        subparser = super().parse_args(subparsers)
+
+        subparser.add_argument(
+            "title", type=str, metavar="<title>", help="title of the task"
+        )
+
+        subparser.add_argument(
+            "-d",
+            "--due",
+            type=str,
+            metavar="<datetime>",
+            help="due date of the task",
+            default=None,
+        )
+        subparser.add_argument(
+            "-p",
+            "--priority",
+            type=str,
+            metavar="<priority>",
+            help="priority of the task",
+            default=None,
+        )
+        subparser.add_argument(
+            "-D",
+            "--duration",
+            type=str,
+            metavar="<duration>",
+            help="duration of the task",
+            default=None,
+        )
+        subparser.add_argument(
+            "-m",
+            "--min-chunk-size",
+            type=str,
+            metavar="<duration>",
+            help="minimum chunk size",
+            default=None,
+        )
+        subparser.add_argument(
+            "-M",
+            "--max-chunk-size",
+            type=str,
+            metavar="<duration>",
+            help="maximum chunk size",
+            default=None,
+        )
+        subparser.add_argument(
+            "-s",
+            "--snooze-until",
+            type=str,
+            metavar="<datetime>",
+            help="snooze until",
+            default=None,
+        )
+
+        return subparser
+
+    def validate_args(self, args):
+        """Validate and transform command arguments."""
+        args = super().validate_args(args)
+
+        # Add custom checks here
+        return args
+
+    def run(self, args):
+        """Create task at Reclaim.ai."""
+        task_args = {"title": args.title}
+
+        # Prepare optional arguments
+        if args.due:
+            task_args["due"] = args.due
+        if args.snooze_until:
+            task_args["snoozeUntil"] = args.snooze_until
+        if args.priority:
+            task_args["priority"] = args.priority
+
+        # Create task and save it
+        task = Task(**task_args)
+
+        # Set optional arguments
+        if args.duration:
+            task.duration = args.duration / 60  # Hours
+        if args.min_chunk_size:
+            task.min_chunk_size = int(args.min_chunk_size / 15)  # Chunks
+        if args.max_chunk_size:
+            task.max_chunk_size = int(args.max_chunk_size / 15)  # Chunks
+
+        # Save task
+        task.save()
+        print_done("Created", task)
+        return task

reclaim_cli-0.1.1/src/reclaim/commands/delete-task.py

@@ -0,0 +1,41 @@
+"""Command to delete a task at Reclaim.ai.
+
+Copyright (c) 2025 Konrad Rieck <konrad@mlsec.org>
+"""
+
+from ..utils import get_task, print_done
+from .base import Command
+
+
+class DeleteTaskCommand(Command):
+    """Delete a task at Reclaim.ai."""
+
+    name = "delete-task"
+    description = "delete a task"
+    aliases = ["delete"]
+
+    def parse_args(self, subparsers):
+        """Add arguments to the subparser."""
+        subparser = super().parse_args(subparsers)
+
+        subparser.add_argument(
+            "id", type=str, metavar="<id>", help="task id to delete"
+        )
+
+        return subparser
+
+    def validate_args(self, args):
+        """Validate and transform command arguments."""
+        args = super().validate_args(args)
+
+        # Add custom checks here
+        return args
+
+    def run(self, args):
+        """Delete tasks at Reclaim.ai."""
+        task = get_task(args.id)
+
+        # Delete task
+        task.delete()
+        print_done("Deleted", task)
+        return None