anki-cli 0.1.0__tar.gz

anki_cli-0.1.0/.gitignore

@@ -0,0 +1,211 @@
+TODO.md
+PLAN.md
+.tmp-proto/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

anki_cli-0.1.0/.python-version

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

anki_cli-0.1.0/LICENSE

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

anki_cli-0.1.0/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.4
+Name: anki-cli
+Version: 0.1.0
+Summary: Hybrid Anki CLI for humans and agents
+Project-URL: Homepage, https://github.com/ubermenchh/anki-cli
+Project-URL: Repository, https://github.com/ubermenchh/anki-cli
+Project-URL: Issues, https://github.com/ubermenchh/anki-cli/issues
+Author: umangkaushik
+License: MIT License
+        
+        Copyright (c) 2026 umangkaushik
+        
+        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: LICENSE
+Keywords: anki,cli,education,flashcards,spaced-repetition
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Education
+Classifier: Topic :: Utilities
+Requires-Python: <3.14,>=3.12
+Requires-Dist: betterproto[compiler]>=2.0.0b7
+Requires-Dist: click
+Requires-Dist: fsrs
+Requires-Dist: httpx
+Requires-Dist: markdownify>=1.2.2
+Requires-Dist: pydantic
+Requires-Dist: pyperclip>=1.11.0
+Requires-Dist: rich
+Provides-Extra: clipboard
+Requires-Dist: pyperclip; extra == 'clipboard'
+Provides-Extra: tui
+Requires-Dist: prompt-toolkit; extra == 'tui'
+Requires-Dist: textual; extra == 'tui'
+Description-Content-Type: text/markdown
+
+# anki-cli
+
+Hybrid Anki CLI for humans and agents.
+
+`anki-cli` supports both:
+
+- AnkiConnect backend (use a running Anki Desktop instance)
+- Direct SQLite backend (operate directly on collection files)
+
+Current release: `0.1.0` (alpha).
+
+## Install
+
+From PyPI (recommended):
+
+```bash
+uv tool install anki-cli
+anki --version
+```
+
+With optional TUI extras:
+
+```bash
+uv tool install "anki-cli[tui]"
+```
+
+## Quick Start
+
+Inspect environment and backend:
+
+```bash
+anki status
+anki version
+```
+
+List core entities:
+
+```bash
+anki decks
+anki notetypes
+anki tags
+```
+
+Query cards and notes:
+
+```bash
+anki cards --query "deck:Default is:due"
+anki notes --query "tag:verb"
+anki search --query "(tag:verb OR tag:noun) -is:suspended"
+```
+
+Inspect individual objects:
+
+```bash
+anki card --id 1234567890
+anki note --id 1234567890
+anki deck --deck "Default"
+anki notetype --name "Basic"
+```
+
+## Backend Modes
+
+Global backend selection:
+
+```bash
+anki --backend auto ...
+anki --backend ankiconnect ...
+anki --backend direct ...
+```
+
+Collection override (direct backend):
+
+```bash
+anki --backend direct --col "/path/to/collection.anki2" status
+```
+
+Backend behavior:
+
+- `auto`: detects and chooses best available backend
+- `ankiconnect`: forwards search queries to `findCards` and `findNotes`
+- `direct`: compiles queries to SQL and executes directly on the collection DB
+
+## Search Query Language
+
+Supported filters:
+
+- `deck:NAME` (supports `*` glob)
+- `notetype:NAME`
+- `tag:NAME` (supports `*` glob)
+- `is:new`, `is:learn`, `is:review`, `is:due`, `is:suspended`, `is:buried`
+- `flag:N`
+- `prop:ivl>N`, `prop:due>N`, `prop:reps>N`, `prop:lapses>N` (`<`, `<=`, `=`, `>=`, `>`)
+- `nid:ID`, `cid:ID`
+- bare text and quoted text (`"specific text"`)
+
+Logical syntax:
+
+- implicit `AND` from whitespace
+- explicit `OR`
+- unary `-` and `NOT`
+- parentheses for grouping
+
+Examples:
+
+```bash
+anki cards --query "deck:Japanese is:due"
+anki cards --query "tag:verb -is:suspended"
+anki notes --query "\"specific text\""
+anki cards --query "(tag:a OR tag:b) is:new"
+```
+
+## Common Commands
+
+### Cards
+
+```bash
+anki cards --query "deck:Default"
+anki card --id 123
+anki card:suspend --query "is:due"
+anki card:unsuspend --id 123
+anki card:move --query "tag:to-move" --deck "Archive"
+anki card:flag --query "is:review" --flag 3
+anki card:bury --query "deck:Default"
+anki card:unbury --deck "Default"
+anki card:reschedule --query "tag:reset-me" --days 3
+anki card:reset --query "tag:relearn"
+anki card:revlog --id 123 --limit 20
+```
+
+### Notes and tags
+
+```bash
+anki notes --query "deck:Default"
+anki note --id 123
+anki note:add --deck "Default" --notetype "Basic" --Front "Q" --Back "A"
+anki note:edit --id 123 --Front "Updated Q" --Back "Updated A"
+anki note:fields --id 123
+anki note:delete --id 123 --yes
+anki tag --tag "verb"
+anki tag:add --query "deck:Default" --tag "important"
+anki tag:remove --id 123 --tag "important"
+anki tag:rename --from "old" --to "new"
+```
+
+### Decks and notetypes
+
+```bash
+anki deck --deck "Default"
+anki deck:create --name "Japanese::Vocab"
+anki deck:rename --from "Old" --to "New"
+anki deck:delete --deck "Temporary" --yes
+anki deck:config --deck "Default"
+anki deck:config:set --deck "Default" --new-per-day 20 --reviews-per-day 200
+
+anki notetypes
+anki notetype --name "Basic"
+anki notetype:create --name "MyType" --field "Front" --field "Back"
+anki notetype:field:add --notetype "Basic" --field "Extra"
+anki notetype:field:remove --notetype "Basic" --field "Extra"
+anki notetype:css --notetype "Basic" --set ".card { font-size: 18px; }"
+```
+
+### Review
+
+```bash
+anki review
+anki review:next
+anki review:show
+anki review:preview --id 123
+anki review:answer --id 123 --rating good
+anki review:undo
+```
+
+Interactive TUI review (requires TUI extras, direct backend):
+
+```bash
+anki review:start --deck "Japanese"
+```
+
+## Output and Exit Codes
+
+Global output formats:
+
+```bash
+anki --format json ...
+anki --format table ...
+anki --format md ...
+anki --format csv ...
+anki --format plain ...
+```
+
+Exit codes:
+
+- `0`: success
+- `1`: backend operation failed
+- `2`: invalid input or confirmation required
+- `4`: entity not found
+- `7`: backend unavailable
+
+## Safety Notes
+
+- Use `--yes` for destructive operations (`note:delete`, `deck:delete`).
+- In direct mode, avoid write operations while Anki Desktop is open.
+- If Anki Desktop is running, prefer `--backend ankiconnect`.
+
+## Development
+
+```bash
+uv sync --group dev
+uv run ruff check .
+uv run ty check
+uv run pytest
+```
+
+With optional TUI dependencies:
+
+```bash
+uv sync --group dev --extra tui
+uv run pytest -m tui
+```
+
+## License
+
+MIT. See `LICENSE`.