fizzydo 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- fizzydo-0.1.0/.gitignore +210 -0
- fizzydo-0.1.0/LICENSE +21 -0
- fizzydo-0.1.0/PKG-INFO +161 -0
- fizzydo-0.1.0/README.md +126 -0
- fizzydo-0.1.0/pyproject.toml +64 -0
- fizzydo-0.1.0/src/fizzydo/__init__.py +1 -0
- fizzydo-0.1.0/src/fizzydo/__main__.py +4 -0
- fizzydo-0.1.0/src/fizzydo/cli.py +165 -0
- fizzydo-0.1.0/src/fizzydo/client.py +186 -0
- fizzydo-0.1.0/src/fizzydo/commands/__init__.py +0 -0
- fizzydo-0.1.0/src/fizzydo/commands/auth.py +54 -0
- fizzydo-0.1.0/src/fizzydo/commands/boards.py +132 -0
- fizzydo-0.1.0/src/fizzydo/commands/cards.py +346 -0
- fizzydo-0.1.0/src/fizzydo/commands/columns.py +134 -0
- fizzydo-0.1.0/src/fizzydo/commands/comments.py +118 -0
- fizzydo-0.1.0/src/fizzydo/commands/pins.py +36 -0
- fizzydo-0.1.0/src/fizzydo/commands/steps.py +111 -0
- fizzydo-0.1.0/src/fizzydo/commands/tags.py +18 -0
- fizzydo-0.1.0/src/fizzydo/config.py +106 -0
- fizzydo-0.1.0/src/fizzydo/errors.py +41 -0
- fizzydo-0.1.0/src/fizzydo/output.py +213 -0
- fizzydo-0.1.0/src/fizzydo/richtext.py +51 -0
- fizzydo-0.1.0/tests/__init__.py +0 -0
- fizzydo-0.1.0/tests/commands/__init__.py +0 -0
- fizzydo-0.1.0/tests/commands/test_auth.py +31 -0
- fizzydo-0.1.0/tests/commands/test_boards.py +68 -0
- fizzydo-0.1.0/tests/commands/test_cards.py +158 -0
- fizzydo-0.1.0/tests/commands/test_columns.py +45 -0
- fizzydo-0.1.0/tests/commands/test_comments.py +48 -0
- fizzydo-0.1.0/tests/commands/test_steps.py +48 -0
- fizzydo-0.1.0/tests/commands/test_tags_and_pins.py +42 -0
- fizzydo-0.1.0/tests/conftest.py +147 -0
- fizzydo-0.1.0/tests/test_account_resolution.py +41 -0
- fizzydo-0.1.0/tests/test_client.py +107 -0
- fizzydo-0.1.0/tests/test_config.py +82 -0
- fizzydo-0.1.0/tests/test_errors.py +26 -0
- fizzydo-0.1.0/tests/test_richtext.py +37 -0
fizzydo-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
CLAUDE.md
|
|
2
|
+
FIZZYDO_AGENT_USE.md
|
|
3
|
+
|
|
4
|
+
# Byte-compiled / optimized / DLL files
|
|
5
|
+
__pycache__/
|
|
6
|
+
*.py[codz]
|
|
7
|
+
*$py.class
|
|
8
|
+
|
|
9
|
+
# C extensions
|
|
10
|
+
*.so
|
|
11
|
+
|
|
12
|
+
# Distribution / packaging
|
|
13
|
+
.Python
|
|
14
|
+
build/
|
|
15
|
+
develop-eggs/
|
|
16
|
+
dist/
|
|
17
|
+
downloads/
|
|
18
|
+
eggs/
|
|
19
|
+
.eggs/
|
|
20
|
+
lib/
|
|
21
|
+
lib64/
|
|
22
|
+
parts/
|
|
23
|
+
sdist/
|
|
24
|
+
var/
|
|
25
|
+
wheels/
|
|
26
|
+
share/python-wheels/
|
|
27
|
+
*.egg-info/
|
|
28
|
+
.installed.cfg
|
|
29
|
+
*.egg
|
|
30
|
+
MANIFEST
|
|
31
|
+
|
|
32
|
+
# PyInstaller
|
|
33
|
+
# Usually these files are written by a python script from a template
|
|
34
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
35
|
+
*.manifest
|
|
36
|
+
*.spec
|
|
37
|
+
|
|
38
|
+
# Installer logs
|
|
39
|
+
pip-log.txt
|
|
40
|
+
pip-delete-this-directory.txt
|
|
41
|
+
|
|
42
|
+
# Unit test / coverage reports
|
|
43
|
+
htmlcov/
|
|
44
|
+
.tox/
|
|
45
|
+
.nox/
|
|
46
|
+
.coverage
|
|
47
|
+
.coverage.*
|
|
48
|
+
.cache
|
|
49
|
+
nosetests.xml
|
|
50
|
+
coverage.xml
|
|
51
|
+
*.cover
|
|
52
|
+
*.py.cover
|
|
53
|
+
.hypothesis/
|
|
54
|
+
.pytest_cache/
|
|
55
|
+
cover/
|
|
56
|
+
|
|
57
|
+
# Translations
|
|
58
|
+
*.mo
|
|
59
|
+
*.pot
|
|
60
|
+
|
|
61
|
+
# Django stuff:
|
|
62
|
+
*.log
|
|
63
|
+
local_settings.py
|
|
64
|
+
db.sqlite3
|
|
65
|
+
db.sqlite3-journal
|
|
66
|
+
|
|
67
|
+
# Flask stuff:
|
|
68
|
+
instance/
|
|
69
|
+
.webassets-cache
|
|
70
|
+
|
|
71
|
+
# Scrapy stuff:
|
|
72
|
+
.scrapy
|
|
73
|
+
|
|
74
|
+
# Sphinx documentation
|
|
75
|
+
docs/_build/
|
|
76
|
+
|
|
77
|
+
# PyBuilder
|
|
78
|
+
.pybuilder/
|
|
79
|
+
target/
|
|
80
|
+
|
|
81
|
+
# Jupyter Notebook
|
|
82
|
+
.ipynb_checkpoints
|
|
83
|
+
|
|
84
|
+
# IPython
|
|
85
|
+
profile_default/
|
|
86
|
+
ipython_config.py
|
|
87
|
+
|
|
88
|
+
# pyenv
|
|
89
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
90
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
91
|
+
# .python-version
|
|
92
|
+
|
|
93
|
+
# pipenv
|
|
94
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
95
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
96
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
97
|
+
# install all needed dependencies.
|
|
98
|
+
#Pipfile.lock
|
|
99
|
+
|
|
100
|
+
# UV
|
|
101
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
102
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
103
|
+
# commonly ignored for libraries.
|
|
104
|
+
#uv.lock
|
|
105
|
+
|
|
106
|
+
# poetry
|
|
107
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
108
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
109
|
+
# commonly ignored for libraries.
|
|
110
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
111
|
+
#poetry.lock
|
|
112
|
+
#poetry.toml
|
|
113
|
+
|
|
114
|
+
# pdm
|
|
115
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
116
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
117
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
118
|
+
#pdm.lock
|
|
119
|
+
#pdm.toml
|
|
120
|
+
.pdm-python
|
|
121
|
+
.pdm-build/
|
|
122
|
+
|
|
123
|
+
# pixi
|
|
124
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
125
|
+
#pixi.lock
|
|
126
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
127
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
128
|
+
.pixi
|
|
129
|
+
|
|
130
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
131
|
+
__pypackages__/
|
|
132
|
+
|
|
133
|
+
# Celery stuff
|
|
134
|
+
celerybeat-schedule
|
|
135
|
+
celerybeat.pid
|
|
136
|
+
|
|
137
|
+
# SageMath parsed files
|
|
138
|
+
*.sage.py
|
|
139
|
+
|
|
140
|
+
# Environments
|
|
141
|
+
.env
|
|
142
|
+
.envrc
|
|
143
|
+
.venv
|
|
144
|
+
env/
|
|
145
|
+
venv/
|
|
146
|
+
ENV/
|
|
147
|
+
env.bak/
|
|
148
|
+
venv.bak/
|
|
149
|
+
|
|
150
|
+
# Spyder project settings
|
|
151
|
+
.spyderproject
|
|
152
|
+
.spyproject
|
|
153
|
+
|
|
154
|
+
# Rope project settings
|
|
155
|
+
.ropeproject
|
|
156
|
+
|
|
157
|
+
# mkdocs documentation
|
|
158
|
+
/site
|
|
159
|
+
|
|
160
|
+
# mypy
|
|
161
|
+
.mypy_cache/
|
|
162
|
+
.dmypy.json
|
|
163
|
+
dmypy.json
|
|
164
|
+
|
|
165
|
+
# Pyre type checker
|
|
166
|
+
.pyre/
|
|
167
|
+
|
|
168
|
+
# pytype static type analyzer
|
|
169
|
+
.pytype/
|
|
170
|
+
|
|
171
|
+
# Cython debug symbols
|
|
172
|
+
cython_debug/
|
|
173
|
+
|
|
174
|
+
# PyCharm
|
|
175
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
176
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
177
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
178
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
179
|
+
#.idea/
|
|
180
|
+
|
|
181
|
+
# Abstra
|
|
182
|
+
# Abstra is an AI-powered process automation framework.
|
|
183
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
184
|
+
# Learn more at https://abstra.io/docs
|
|
185
|
+
.abstra/
|
|
186
|
+
|
|
187
|
+
# Visual Studio Code
|
|
188
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
189
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
190
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
191
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
192
|
+
# .vscode/
|
|
193
|
+
|
|
194
|
+
# Ruff stuff:
|
|
195
|
+
.ruff_cache/
|
|
196
|
+
|
|
197
|
+
# PyPI configuration file
|
|
198
|
+
.pypirc
|
|
199
|
+
|
|
200
|
+
# Cursor
|
|
201
|
+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
|
|
202
|
+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
|
|
203
|
+
# refer to https://docs.cursor.com/context/ignore-files
|
|
204
|
+
.cursorignore
|
|
205
|
+
.cursorindexingignore
|
|
206
|
+
|
|
207
|
+
# Marimo
|
|
208
|
+
marimo/_static/
|
|
209
|
+
marimo/_lsp/
|
|
210
|
+
__marimo__/
|
fizzydo-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Delip Rao
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
fizzydo-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: fizzydo
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Command-line client for the fizzy.do kanban API
|
|
5
|
+
Project-URL: Homepage, https://github.com/delip/fizzy-cli
|
|
6
|
+
Project-URL: Repository, https://github.com/delip/fizzy-cli
|
|
7
|
+
Project-URL: Issues, https://github.com/delip/fizzy-cli/issues
|
|
8
|
+
Author: Delip Rao
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: cli,fizzy,fizzy.do,kanban,productivity,task-management
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Environment :: Console
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
+
Classifier: Topic :: Office/Business :: Scheduling
|
|
21
|
+
Classifier: Topic :: Software Development
|
|
22
|
+
Classifier: Topic :: Utilities
|
|
23
|
+
Requires-Python: >=3.11
|
|
24
|
+
Requires-Dist: httpx>=0.27
|
|
25
|
+
Requires-Dist: markdown-it-py>=3.0
|
|
26
|
+
Requires-Dist: python-dotenv>=1.0
|
|
27
|
+
Requires-Dist: rich>=13.7
|
|
28
|
+
Requires-Dist: typer>=0.12
|
|
29
|
+
Provides-Extra: dev
|
|
30
|
+
Requires-Dist: build>=1.2; extra == 'dev'
|
|
31
|
+
Requires-Dist: pytest-httpx>=0.30; extra == 'dev'
|
|
32
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
33
|
+
Requires-Dist: twine>=5.1; extra == 'dev'
|
|
34
|
+
Description-Content-Type: text/markdown
|
|
35
|
+
|
|
36
|
+
# fizzydo
|
|
37
|
+
|
|
38
|
+
Command-line client for the [fizzy.do](https://fizzy.do) kanban API.
|
|
39
|
+
|
|
40
|
+
`fizzydo` is a thin, ergonomic CLI over the fizzy.do REST API for boards, columns, cards, comments, steps, tags, and pins. Resource-first command shape: `fizzydo cards list`, `fizzydo boards create --name ...`, `fizzydo cards close 42`.
|
|
41
|
+
|
|
42
|
+
## Install
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
pip install fizzydo
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Or with [pipx](https://pipx.pypa.io) / [uv](https://github.com/astral-sh/uv) for an isolated install:
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
pipx install fizzydo
|
|
52
|
+
# or
|
|
53
|
+
uv tool install fizzydo
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
For development against a local checkout:
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
pip install -e ".[dev]"
|
|
60
|
+
pytest
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Requires Python 3.11+.
|
|
64
|
+
|
|
65
|
+
## Authentication
|
|
66
|
+
|
|
67
|
+
`fizzydo` authenticates with a personal access token from your fizzy.do profile (Profile → API → Personal access tokens → Generate new access token).
|
|
68
|
+
|
|
69
|
+
Set the token in `FIZZYDO_API_KEY`:
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
export FIZZYDO_API_KEY=your-token-here
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
If the env var is unset, `fizzydo` reads it from a `.env` file. Lookup order:
|
|
76
|
+
|
|
77
|
+
1. `--env-file-path <path>` (explicit override)
|
|
78
|
+
2. `./.env` (current directory)
|
|
79
|
+
3. `$HOME/.env`
|
|
80
|
+
|
|
81
|
+
A `.env` looks like:
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
FIZZYDO_API_KEY=your-token-here
|
|
85
|
+
FIZZYDO_ACCOUNT=897362094 # optional, account slug
|
|
86
|
+
FIZZYDO_BASE_URL=https://app.fizzy.do # optional
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Quick start
|
|
90
|
+
|
|
91
|
+
```sh
|
|
92
|
+
fizzydo auth whoami # list your accounts
|
|
93
|
+
fizzydo boards list # see your boards
|
|
94
|
+
fizzydo cards list --mine # cards assigned to you
|
|
95
|
+
|
|
96
|
+
# Create, comment on, and close a card
|
|
97
|
+
BOARD=$(fizzydo boards list --id | head -1)
|
|
98
|
+
fizzydo cards create --board "$BOARD" --title "Add dark mode" --description "We need dark mode."
|
|
99
|
+
fizzydo comments add 42 "Started looking into this."
|
|
100
|
+
fizzydo cards close 42
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Output modes
|
|
104
|
+
|
|
105
|
+
- Default: human-friendly Rich tables.
|
|
106
|
+
- `--json` — emit raw JSON for piping into `jq`.
|
|
107
|
+
- `--id` — emit only IDs (or card numbers), one per line, for scripting:
|
|
108
|
+
|
|
109
|
+
```sh
|
|
110
|
+
fizzydo cards list --mine --id | xargs -n1 fizzydo cards close
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Rich-text input
|
|
114
|
+
|
|
115
|
+
`--description` (cards) and the comment body argument accept several input forms:
|
|
116
|
+
|
|
117
|
+
- Inline plain text: `--description "Quick note"`
|
|
118
|
+
- A Markdown file: `--description @notes.md`
|
|
119
|
+
- An HTML file: `--description @body.html`
|
|
120
|
+
- Stdin (Markdown): `--description -`
|
|
121
|
+
- An editor: `comments add 42 --editor`
|
|
122
|
+
|
|
123
|
+
## Commands
|
|
124
|
+
|
|
125
|
+
| Resource | Subcommands |
|
|
126
|
+
|---|---|
|
|
127
|
+
| `auth` | `whoami`, `status` |
|
|
128
|
+
| `boards` | `list`, `show`, `create`, `update`, `delete`, `publish`, `unpublish` |
|
|
129
|
+
| `columns` | `list`, `show`, `create`, `update`, `delete` |
|
|
130
|
+
| `cards` | `list`, `show`, `create`, `update`, `delete`, `close`, `reopen`, `not-now`, `triage`, `untriage`, `tag`, `assign`, `golden`, `ungolden`, `watch`, `unwatch` |
|
|
131
|
+
| `comments` | `list`, `show`, `add`, `update`, `delete` |
|
|
132
|
+
| `steps` | `list`, `add`, `done`, `undo`, `update`, `delete` |
|
|
133
|
+
| `tags` | `list` |
|
|
134
|
+
| `pins` | `list`, `add`, `remove` |
|
|
135
|
+
|
|
136
|
+
Run `fizzydo <resource> --help` for full options on any subcommand.
|
|
137
|
+
|
|
138
|
+
## Exit codes
|
|
139
|
+
|
|
140
|
+
| Code | Meaning |
|
|
141
|
+
|---|---|
|
|
142
|
+
| `0` | Success |
|
|
143
|
+
| `1` | Generic / network / config error |
|
|
144
|
+
| `2` | 401 Unauthorized |
|
|
145
|
+
| `3` | 403 Forbidden |
|
|
146
|
+
| `4` | 404 Not Found |
|
|
147
|
+
| `5` | 422 Unprocessable Entity (validation) |
|
|
148
|
+
| `6` | 429 Too Many Requests |
|
|
149
|
+
| `7` | 5xx Server Error |
|
|
150
|
+
|
|
151
|
+
## Using fizzydo from an agent
|
|
152
|
+
|
|
153
|
+
`fizzydo` is designed to be driven by coding agents (Claude Code, Codex CLI, etc.) for project task tracking. The recommended workflow — one board per project, three columns (`TODO`/`DOING`/`DONE`), cards moved through them as work progresses — is documented in [FIZZYDO_AGENT_USE.md](FIZZYDO_AGENT_USE.md). Point your agent at that file at the start of a session.
|
|
154
|
+
|
|
155
|
+
## Not yet implemented
|
|
156
|
+
|
|
157
|
+
Webhooks, notifications, reactions, users admin, account settings, file/image uploads, and ETag-based caching are deferred to follow-up iterations. The fizzy.do API spec lives in `Fizzy_API.md` if you want to track what's still missing.
|
|
158
|
+
|
|
159
|
+
## License
|
|
160
|
+
|
|
161
|
+
MIT — see `LICENSE`.
|
fizzydo-0.1.0/README.md
ADDED
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# fizzydo
|
|
2
|
+
|
|
3
|
+
Command-line client for the [fizzy.do](https://fizzy.do) kanban API.
|
|
4
|
+
|
|
5
|
+
`fizzydo` is a thin, ergonomic CLI over the fizzy.do REST API for boards, columns, cards, comments, steps, tags, and pins. Resource-first command shape: `fizzydo cards list`, `fizzydo boards create --name ...`, `fizzydo cards close 42`.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
pip install fizzydo
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Or with [pipx](https://pipx.pypa.io) / [uv](https://github.com/astral-sh/uv) for an isolated install:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
pipx install fizzydo
|
|
17
|
+
# or
|
|
18
|
+
uv tool install fizzydo
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
For development against a local checkout:
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
pip install -e ".[dev]"
|
|
25
|
+
pytest
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Requires Python 3.11+.
|
|
29
|
+
|
|
30
|
+
## Authentication
|
|
31
|
+
|
|
32
|
+
`fizzydo` authenticates with a personal access token from your fizzy.do profile (Profile → API → Personal access tokens → Generate new access token).
|
|
33
|
+
|
|
34
|
+
Set the token in `FIZZYDO_API_KEY`:
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
export FIZZYDO_API_KEY=your-token-here
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
If the env var is unset, `fizzydo` reads it from a `.env` file. Lookup order:
|
|
41
|
+
|
|
42
|
+
1. `--env-file-path <path>` (explicit override)
|
|
43
|
+
2. `./.env` (current directory)
|
|
44
|
+
3. `$HOME/.env`
|
|
45
|
+
|
|
46
|
+
A `.env` looks like:
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
FIZZYDO_API_KEY=your-token-here
|
|
50
|
+
FIZZYDO_ACCOUNT=897362094 # optional, account slug
|
|
51
|
+
FIZZYDO_BASE_URL=https://app.fizzy.do # optional
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Quick start
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
fizzydo auth whoami # list your accounts
|
|
58
|
+
fizzydo boards list # see your boards
|
|
59
|
+
fizzydo cards list --mine # cards assigned to you
|
|
60
|
+
|
|
61
|
+
# Create, comment on, and close a card
|
|
62
|
+
BOARD=$(fizzydo boards list --id | head -1)
|
|
63
|
+
fizzydo cards create --board "$BOARD" --title "Add dark mode" --description "We need dark mode."
|
|
64
|
+
fizzydo comments add 42 "Started looking into this."
|
|
65
|
+
fizzydo cards close 42
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Output modes
|
|
69
|
+
|
|
70
|
+
- Default: human-friendly Rich tables.
|
|
71
|
+
- `--json` — emit raw JSON for piping into `jq`.
|
|
72
|
+
- `--id` — emit only IDs (or card numbers), one per line, for scripting:
|
|
73
|
+
|
|
74
|
+
```sh
|
|
75
|
+
fizzydo cards list --mine --id | xargs -n1 fizzydo cards close
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Rich-text input
|
|
79
|
+
|
|
80
|
+
`--description` (cards) and the comment body argument accept several input forms:
|
|
81
|
+
|
|
82
|
+
- Inline plain text: `--description "Quick note"`
|
|
83
|
+
- A Markdown file: `--description @notes.md`
|
|
84
|
+
- An HTML file: `--description @body.html`
|
|
85
|
+
- Stdin (Markdown): `--description -`
|
|
86
|
+
- An editor: `comments add 42 --editor`
|
|
87
|
+
|
|
88
|
+
## Commands
|
|
89
|
+
|
|
90
|
+
| Resource | Subcommands |
|
|
91
|
+
|---|---|
|
|
92
|
+
| `auth` | `whoami`, `status` |
|
|
93
|
+
| `boards` | `list`, `show`, `create`, `update`, `delete`, `publish`, `unpublish` |
|
|
94
|
+
| `columns` | `list`, `show`, `create`, `update`, `delete` |
|
|
95
|
+
| `cards` | `list`, `show`, `create`, `update`, `delete`, `close`, `reopen`, `not-now`, `triage`, `untriage`, `tag`, `assign`, `golden`, `ungolden`, `watch`, `unwatch` |
|
|
96
|
+
| `comments` | `list`, `show`, `add`, `update`, `delete` |
|
|
97
|
+
| `steps` | `list`, `add`, `done`, `undo`, `update`, `delete` |
|
|
98
|
+
| `tags` | `list` |
|
|
99
|
+
| `pins` | `list`, `add`, `remove` |
|
|
100
|
+
|
|
101
|
+
Run `fizzydo <resource> --help` for full options on any subcommand.
|
|
102
|
+
|
|
103
|
+
## Exit codes
|
|
104
|
+
|
|
105
|
+
| Code | Meaning |
|
|
106
|
+
|---|---|
|
|
107
|
+
| `0` | Success |
|
|
108
|
+
| `1` | Generic / network / config error |
|
|
109
|
+
| `2` | 401 Unauthorized |
|
|
110
|
+
| `3` | 403 Forbidden |
|
|
111
|
+
| `4` | 404 Not Found |
|
|
112
|
+
| `5` | 422 Unprocessable Entity (validation) |
|
|
113
|
+
| `6` | 429 Too Many Requests |
|
|
114
|
+
| `7` | 5xx Server Error |
|
|
115
|
+
|
|
116
|
+
## Using fizzydo from an agent
|
|
117
|
+
|
|
118
|
+
`fizzydo` is designed to be driven by coding agents (Claude Code, Codex CLI, etc.) for project task tracking. The recommended workflow — one board per project, three columns (`TODO`/`DOING`/`DONE`), cards moved through them as work progresses — is documented in [FIZZYDO_AGENT_USE.md](FIZZYDO_AGENT_USE.md). Point your agent at that file at the start of a session.
|
|
119
|
+
|
|
120
|
+
## Not yet implemented
|
|
121
|
+
|
|
122
|
+
Webhooks, notifications, reactions, users admin, account settings, file/image uploads, and ETag-based caching are deferred to follow-up iterations. The fizzy.do API spec lives in `Fizzy_API.md` if you want to track what's still missing.
|
|
123
|
+
|
|
124
|
+
## License
|
|
125
|
+
|
|
126
|
+
MIT — see `LICENSE`.
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling>=1.26"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "fizzydo"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Command-line client for the fizzy.do kanban API"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "MIT"
|
|
11
|
+
license-files = ["LICENSE"]
|
|
12
|
+
requires-python = ">=3.11"
|
|
13
|
+
authors = [{ name = "Delip Rao" }]
|
|
14
|
+
keywords = ["fizzy", "fizzy.do", "kanban", "cli", "task-management", "productivity"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 3 - Alpha",
|
|
17
|
+
"Environment :: Console",
|
|
18
|
+
"Intended Audience :: Developers",
|
|
19
|
+
"Operating System :: OS Independent",
|
|
20
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Programming Language :: Python :: 3.13",
|
|
24
|
+
"Topic :: Office/Business :: Scheduling",
|
|
25
|
+
"Topic :: Software Development",
|
|
26
|
+
"Topic :: Utilities",
|
|
27
|
+
]
|
|
28
|
+
dependencies = [
|
|
29
|
+
"typer>=0.12",
|
|
30
|
+
"httpx>=0.27",
|
|
31
|
+
"rich>=13.7",
|
|
32
|
+
"python-dotenv>=1.0",
|
|
33
|
+
"markdown-it-py>=3.0",
|
|
34
|
+
]
|
|
35
|
+
|
|
36
|
+
[project.optional-dependencies]
|
|
37
|
+
dev = [
|
|
38
|
+
"pytest>=8.0",
|
|
39
|
+
"pytest-httpx>=0.30",
|
|
40
|
+
"build>=1.2",
|
|
41
|
+
"twine>=5.1",
|
|
42
|
+
]
|
|
43
|
+
|
|
44
|
+
[project.scripts]
|
|
45
|
+
fizzydo = "fizzydo.cli:main"
|
|
46
|
+
|
|
47
|
+
[project.urls]
|
|
48
|
+
Homepage = "https://github.com/delip/fizzy-cli"
|
|
49
|
+
Repository = "https://github.com/delip/fizzy-cli"
|
|
50
|
+
Issues = "https://github.com/delip/fizzy-cli/issues"
|
|
51
|
+
|
|
52
|
+
[tool.hatch.build.targets.wheel]
|
|
53
|
+
packages = ["src/fizzydo"]
|
|
54
|
+
|
|
55
|
+
[tool.hatch.build.targets.sdist]
|
|
56
|
+
exclude = [
|
|
57
|
+
"Fizzy_API.md",
|
|
58
|
+
".github",
|
|
59
|
+
".pytest_cache",
|
|
60
|
+
]
|
|
61
|
+
|
|
62
|
+
[tool.pytest.ini_options]
|
|
63
|
+
testpaths = ["tests"]
|
|
64
|
+
addopts = "-ra"
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.1.0"
|