cctodo 0.1.0__tar.gz

cctodo-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CloudCircus
+
+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.

cctodo-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: cctodo
+Version: 0.1.0
+Summary: Command line tool and Python client for ccToDo (www.cctodo.com)
+Author-email: CloudCircus <support@cctodo.com>
+License-Expression: MIT
+Project-URL: Homepage, https://www.cctodo.com/
+Project-URL: Source, https://github.com/RubenNorgaard/cctodo_py
+Keywords: todo,tasks,cli,cctodo
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Scheduling
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# cctodo
+
+The command line tool and Python client for [ccToDo](https://www.cctodo.com/), made by CloudCircus.
+
+```sh
+pip install cctodo
+cctodo login          # paste a token from Settings → API tokens
+cctodo mytasks
+cctodo new -group "work group" "my task"
+cctodo done 123
+```
+
+It uses only the Python standard library and needs Python 3.9 or newer.
+
+## Commands
+
+Tasks are shown with their id (`#123`), and the commands take that id. Where a command takes a group,
+you can give its id, its title, or the start of the title (case-insensitive). Without `-g`, commands
+use your **My Tasks**.
+
+| Command | What it does |
+|---|---|
+| `cctodo mytasks` (`my`) | Your pending My Tasks. `-c` shows completed tasks instead. |
+| `cctodo list [GROUP]` (`ls`) | A group's pending tasks. `--all` lists every group, `-c` shows completed tasks. |
+| `cctodo assigned` | Pending tasks assigned to you, in all groups. |
+| `cctodo groups` | Your groups, with their pending counts. |
+| `cctodo new TITLE… [-g GROUP] [-a WHO] [-b BODY] [-e]` (`add`) | Adds a task at the bottom of the list. `-b -` reads the details from stdin; `-e` writes the title and details in `$EDITOR`. |
+| `cctodo show ID` | A task with its details (markdown) and comments. |
+| `cctodo done ID…` / `start ID…` / `reopen ID…` | Sets the state to done, in progress, or to do. |
+| `cctodo edit ID [-t TITLE] [-b BODY]` | Edits a task. With no options it opens `$EDITOR`: the first line is the title and the rest is the details. It refuses to overwrite someone else's newer edit. |
+| `cctodo assign ID WHO` | Assigns to `me`, a member's email, or `none`. |
+| `cctodo mv ID -g GROUP` / `mv ID --before ID2` / `--after ID2` | Moves a task to another group, or reorders it. |
+| `cctodo rm ID… [-y]` | Deletes tasks after asking you to confirm. |
+| `cctodo comment ID TEXT… [-r COMMENT_ID]` | Adds a comment, or a reply with `-r`. |
+| `cctodo group new/rename/members/leave/rm` | Manages groups. |
+| `cctodo invite GROUP EMAIL [-m MESSAGE]` | Invites someone. If you're a member rather than an owner, an owner approves the invite first. |
+| `cctodo invites` / `accept ID` / `decline ID` | Lists and answers invites addressed to you. |
+| `cctodo whoami` / `logout` | Shows the account you're logged in as, or forgets the saved token. |
+
+Add `--json` to any command for the raw API output. `NO_COLOR` turns colours off.
+
+**Exit codes:**
+- `0`: the command succeeded.
+- `1`: an error occurred.
+- `3`: you're not logged in, or your token was revoked.
+
+## Configuration
+
+`cctodo login` saves the token in `~/.config/cctodo/config.json`, readable only by you
+(`%APPDATA%\cctodo\config.json` on Windows). You can set these environment variables instead:
+
+- `CCTODO_TOKEN`: the API token.
+- `CCTODO_API_URL`: the API address. It defaults to `https://api.cctodo.com`.
+- `CCTODO_CONFIG`: a different config file.
+
+To revoke a token, go to Settings → API tokens on www.cctodo.com.
+
+## Python
+
+```python
+from cctodo import Client, Conflict
+
+todo = Client()                                  # the same token as the CLI (or Client(token="cct_..."))
+work = todo.find_group("work group")
+task = todo.create_task(work.id, "Write the report", body="Due **Friday**")
+todo.assign(task.id, todo.me().id)
+todo.start(task.id)
+
+for t in todo.tasks(work.id):                    # pending tasks, in order
+    print(t.id, t.state, t.title)                # attribute or t["title"] access
+
+try:
+    todo.update_task(task.id, body="…", expected_updated_at=task.updated_at)
+except Conflict:
+    print("Someone else changed it first")
+```
+
+**Return values:** results are the API's JSON as `Record` objects (dicts with attribute access).
+
+**Errors:** errors raise `cctodo.NotFound` (404; this also covers groups you're not in), `NotAllowed` (403),
+`Invalid` (400), `Conflict` (409), `RateLimited` (429) or `Unauthorized` (401). All of them subclass `cctodo.CctodoError`.
+
+## Development
+
+```sh
+pip install -e .
+python -m unittest discover -s . -t .
+CCTODO_API_URL=http://api.localhost:8000 cctodo whoami      # against a local cctodo_web
+```
+
+## Licence
+
+MIT. See [LICENSE](LICENSE).

cctodo-0.1.0/README.md

@@ -0,0 +1,93 @@
+# cctodo
+
+The command line tool and Python client for [ccToDo](https://www.cctodo.com/), made by CloudCircus.
+
+```sh
+pip install cctodo
+cctodo login          # paste a token from Settings → API tokens
+cctodo mytasks
+cctodo new -group "work group" "my task"
+cctodo done 123
+```
+
+It uses only the Python standard library and needs Python 3.9 or newer.
+
+## Commands
+
+Tasks are shown with their id (`#123`), and the commands take that id. Where a command takes a group,
+you can give its id, its title, or the start of the title (case-insensitive). Without `-g`, commands
+use your **My Tasks**.
+
+| Command | What it does |
+|---|---|
+| `cctodo mytasks` (`my`) | Your pending My Tasks. `-c` shows completed tasks instead. |
+| `cctodo list [GROUP]` (`ls`) | A group's pending tasks. `--all` lists every group, `-c` shows completed tasks. |
+| `cctodo assigned` | Pending tasks assigned to you, in all groups. |
+| `cctodo groups` | Your groups, with their pending counts. |
+| `cctodo new TITLE… [-g GROUP] [-a WHO] [-b BODY] [-e]` (`add`) | Adds a task at the bottom of the list. `-b -` reads the details from stdin; `-e` writes the title and details in `$EDITOR`. |
+| `cctodo show ID` | A task with its details (markdown) and comments. |
+| `cctodo done ID…` / `start ID…` / `reopen ID…` | Sets the state to done, in progress, or to do. |
+| `cctodo edit ID [-t TITLE] [-b BODY]` | Edits a task. With no options it opens `$EDITOR`: the first line is the title and the rest is the details. It refuses to overwrite someone else's newer edit. |
+| `cctodo assign ID WHO` | Assigns to `me`, a member's email, or `none`. |
+| `cctodo mv ID -g GROUP` / `mv ID --before ID2` / `--after ID2` | Moves a task to another group, or reorders it. |
+| `cctodo rm ID… [-y]` | Deletes tasks after asking you to confirm. |
+| `cctodo comment ID TEXT… [-r COMMENT_ID]` | Adds a comment, or a reply with `-r`. |
+| `cctodo group new/rename/members/leave/rm` | Manages groups. |
+| `cctodo invite GROUP EMAIL [-m MESSAGE]` | Invites someone. If you're a member rather than an owner, an owner approves the invite first. |
+| `cctodo invites` / `accept ID` / `decline ID` | Lists and answers invites addressed to you. |
+| `cctodo whoami` / `logout` | Shows the account you're logged in as, or forgets the saved token. |
+
+Add `--json` to any command for the raw API output. `NO_COLOR` turns colours off.
+
+**Exit codes:**
+- `0`: the command succeeded.
+- `1`: an error occurred.
+- `3`: you're not logged in, or your token was revoked.
+
+## Configuration
+
+`cctodo login` saves the token in `~/.config/cctodo/config.json`, readable only by you
+(`%APPDATA%\cctodo\config.json` on Windows). You can set these environment variables instead:
+
+- `CCTODO_TOKEN`: the API token.
+- `CCTODO_API_URL`: the API address. It defaults to `https://api.cctodo.com`.
+- `CCTODO_CONFIG`: a different config file.
+
+To revoke a token, go to Settings → API tokens on www.cctodo.com.
+
+## Python
+
+```python
+from cctodo import Client, Conflict
+
+todo = Client()                                  # the same token as the CLI (or Client(token="cct_..."))
+work = todo.find_group("work group")
+task = todo.create_task(work.id, "Write the report", body="Due **Friday**")
+todo.assign(task.id, todo.me().id)
+todo.start(task.id)
+
+for t in todo.tasks(work.id):                    # pending tasks, in order
+    print(t.id, t.state, t.title)                # attribute or t["title"] access
+
+try:
+    todo.update_task(task.id, body="…", expected_updated_at=task.updated_at)
+except Conflict:
+    print("Someone else changed it first")
+```
+
+**Return values:** results are the API's JSON as `Record` objects (dicts with attribute access).
+
+**Errors:** errors raise `cctodo.NotFound` (404; this also covers groups you're not in), `NotAllowed` (403),
+`Invalid` (400), `Conflict` (409), `RateLimited` (429) or `Unauthorized` (401). All of them subclass `cctodo.CctodoError`.
+
+## Development
+
+```sh
+pip install -e .
+python -m unittest discover -s . -t .
+CCTODO_API_URL=http://api.localhost:8000 cctodo whoami      # against a local cctodo_web
+```
+
+## Licence
+
+MIT. See [LICENSE](LICENSE).

cctodo-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cctodo"
+dynamic = ["version"]
+description = "Command line tool and Python client for ccToDo (www.cctodo.com)"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+authors = [{ name = "CloudCircus", email = "support@cctodo.com" }]
+keywords = ["todo", "tasks", "cli", "cctodo"]
+classifiers = [
+    "Environment :: Console",
+    "Programming Language :: Python :: 3",
+    "Topic :: Office/Business :: Scheduling",
+]
+dependencies = []  # standard library only
+
+[project.urls]
+Homepage = "https://www.cctodo.com/"
+Source = "https://github.com/RubenNorgaard/cctodo_py"
+
+[project.scripts]
+cctodo = "cctodo.cli:main"
+
+[tool.setuptools.dynamic]
+version = { attr = "cctodo.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]

cctodo-0.1.0/setup.cfg

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

cctodo-0.1.0/src/cctodo/__init__.py

@@ -0,0 +1,10 @@
+"""Command line tool and Python client for ccToDo (https://www.cctodo.com/)."""
+
+__version__ = "0.1.0"
+
+from .client import DONE, IN_PROGRESS, TODO, Client, Record  # noqa: E402
+from .errors import (ApiError, CctodoError, ConfigError, Conflict, ConnectionFailed, Invalid,  # noqa: E402
+                     NotAllowed, NotFound, RateLimited, Unauthorized)
+
+__all__ = ["Client", "Record", "TODO", "IN_PROGRESS", "DONE", "CctodoError", "ApiError", "ConfigError",
+           "ConnectionFailed", "Unauthorized", "NotAllowed", "NotFound", "Invalid", "Conflict", "RateLimited"]

cctodo-0.1.0/src/cctodo/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+raise SystemExit(main())