csrd-utils 0.1.10__tar.gz → 0.3.4__tar.gz

csrd_utils-0.3.4/.gitignore

@@ -0,0 +1,217 @@
+# 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__/
+
+*.db
+
+
+# Import linter cache
+.import_linter_cache/
+
+# IDE
+.idea/
+.idea/*

csrd_utils-0.3.4/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: csrd-utils
+Version: 0.3.4
+Summary: CLI utilities for csrd service generation and feature augmentation
+Project-URL: Repository, https://github.com/csrd-api/fastapi-common
+Project-URL: Documentation, https://github.com/csrd-api/fastapi-common/tree/main/packages/utils
+Project-URL: Changelog, https://github.com/csrd-api/fastapi-common/blob/main/CHANGELOG.md
+License: MIT
+Requires-Python: >=3.12
+Requires-Dist: cookiecutter<3,>=2.6
+Requires-Dist: pyyaml<7,>=6
+Description-Content-Type: text/markdown
+
+# csrd-utils
+
+CLI and runtime helpers for generating csrd services and augmenting existing services with optional features.
+
+## Install
+
+```bash
+pip install "csrd-utils @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/utils"
+```
+
+## CLI
+
+```bash
+csrd --help
+csrd new service                                  # interactive prompts
+csrd new service --interactive --name items       # pre-fills name prompt with 'items'
+csrd new service --name inventory --no-interactive --output .
+csrd feature list
+csrd feature plan workers --service .
+csrd feature plan workers --service . --json
+csrd feature add workers --service .
+csrd doctor --service .
+```
+
+`feature plan --json` is useful for CI or tooling wrappers.
+
+### Interactive generation behavior
+
+- `csrd new service` runs interactive prompts by default.
+- Passing `--name <value>` in interactive mode uses that value as the name prompt default.
+- You can still overwrite the default by entering a different value at the prompt.
+- Use `--no-interactive` for fully flag-driven generation.
+
+## Typical workflow
+
+```bash
+# 0) Generate a new service from bundled template
+csrd new service --name inventory --output . --database postgres --workers
+
+# 1) Verify service compatibility
+csrd doctor --service ./inventory
+
+# 2) Inspect available bundled features
+csrd feature list
+
+# 3) Dry-run a feature
+csrd feature plan workers --service ./inventory
+
+# 4) Apply feature files/merges
+csrd feature add workers --service ./inventory
+```
+
+## Bundled assets
+
+- `features/workers/` feature manifests and fragments
+- `templates/cookiecutter-service/` template starter
+
+## Python API
+
+```python
+from pathlib import Path
+from csrd_utils import ServiceAugmentor
+from csrd_utils.resources import features_path
+
+with features_path() as feature_lib:
+    augmentor = ServiceAugmentor(Path("."), feature_lib)
+    ok, changes = augmentor.add_feature("workers", plan=True)
+```
+
+## Documentation
+
+- `docs/CLI_REFERENCE.md` - full command/flag reference
+- `docs/FEATURES.md` - bundled feature catalog and behavior
+- `docs/AGENT_SMOKE_TESTS.md` - copy/paste validation flow for clean workspaces
+- `docs/COMMAND_MATRIX.yaml` - machine-readable command matrix for automation
+- `AGENTS.md` - package-local rules for autonomous agents
+
+## CLI-only agent mode
+
+If an agent can only see the installed CLI (not source files), use this exploration sequence:
+
+```bash
+csrd --help
+csrd new --help
+csrd feature --help
+csrd doctor --help
+csrd feature list
+```
+
+Then run a clean smoke flow:
+
+```bash
+mkdir -p /tmp/csrd-smoke
+cd /tmp/csrd-smoke
+csrd new service --name demo-svc --output . --no-interactive
+cd demo-svc
+csrd doctor
+csrd feature plan workers
+csrd feature add workers
+```

csrd_utils-0.3.4/README.md

@@ -0,0 +1,100 @@
+# csrd-utils
+
+CLI and runtime helpers for generating csrd services and augmenting existing services with optional features.
+
+## Install
+
+```bash
+pip install "csrd-utils @ git+https://github.com/csrd-api/fastapi-common.git#subdirectory=packages/utils"
+```
+
+## CLI
+
+```bash
+csrd --help
+csrd new service                                  # interactive prompts
+csrd new service --interactive --name items       # pre-fills name prompt with 'items'
+csrd new service --name inventory --no-interactive --output .
+csrd feature list
+csrd feature plan workers --service .
+csrd feature plan workers --service . --json
+csrd feature add workers --service .
+csrd doctor --service .
+```
+
+`feature plan --json` is useful for CI or tooling wrappers.
+
+### Interactive generation behavior
+
+- `csrd new service` runs interactive prompts by default.
+- Passing `--name <value>` in interactive mode uses that value as the name prompt default.
+- You can still overwrite the default by entering a different value at the prompt.
+- Use `--no-interactive` for fully flag-driven generation.
+
+## Typical workflow
+
+```bash
+# 0) Generate a new service from bundled template
+csrd new service --name inventory --output . --database postgres --workers
+
+# 1) Verify service compatibility
+csrd doctor --service ./inventory
+
+# 2) Inspect available bundled features
+csrd feature list
+
+# 3) Dry-run a feature
+csrd feature plan workers --service ./inventory
+
+# 4) Apply feature files/merges
+csrd feature add workers --service ./inventory
+```
+
+## Bundled assets
+
+- `features/workers/` feature manifests and fragments
+- `templates/cookiecutter-service/` template starter
+
+## Python API
+
+```python
+from pathlib import Path
+from csrd_utils import ServiceAugmentor
+from csrd_utils.resources import features_path
+
+with features_path() as feature_lib:
+    augmentor = ServiceAugmentor(Path("."), feature_lib)
+    ok, changes = augmentor.add_feature("workers", plan=True)
+```
+
+## Documentation
+
+- `docs/CLI_REFERENCE.md` - full command/flag reference
+- `docs/FEATURES.md` - bundled feature catalog and behavior
+- `docs/AGENT_SMOKE_TESTS.md` - copy/paste validation flow for clean workspaces
+- `docs/COMMAND_MATRIX.yaml` - machine-readable command matrix for automation
+- `AGENTS.md` - package-local rules for autonomous agents
+
+## CLI-only agent mode
+
+If an agent can only see the installed CLI (not source files), use this exploration sequence:
+
+```bash
+csrd --help
+csrd new --help
+csrd feature --help
+csrd doctor --help
+csrd feature list
+```
+
+Then run a clean smoke flow:
+
+```bash
+mkdir -p /tmp/csrd-smoke
+cd /tmp/csrd-smoke
+csrd new service --name demo-svc --output . --no-interactive
+cd demo-svc
+csrd doctor
+csrd feature plan workers
+csrd feature add workers
+```

csrd_utils-0.3.4/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "csrd-utils"
+version = "0.3.4"
+description = "CLI utilities for csrd service generation and feature augmentation"
+license = { text = "MIT" }
+requires-python = ">=3.12"
+dependencies = [
+    "cookiecutter>=2.6,<3",
+    "PyYAML>=6,<7",
+]
+readme = "README.md"
+
+[project.scripts]
+csrd = "csrd_utils.__main__:main"
+csrd-utils = "csrd_utils.__main__:main"
+
+[project.urls]
+Repository = "https://github.com/csrd-api/fastapi-common"
+Documentation = "https://github.com/csrd-api/fastapi-common/tree/main/packages/utils"
+Changelog = "https://github.com/csrd-api/fastapi-common/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/csrd_utils"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/csrd_utils/**",
+    "README.md",
+    "pyproject.toml",
+]

csrd_utils-0.3.4/src/csrd_utils/__init__.py

@@ -0,0 +1,7 @@
+"""csrd-utils: template and feature tooling for csrd services."""
+
+from .augmentor import ServiceAugmentor
+from .doctor import run_doctor
+from .generator import generate_service
+
+__all__ = ["ServiceAugmentor", "generate_service", "run_doctor"]