Skip to main content

CLI for scaffolding Robyn backend templates (DDD/MVC with SQLAlchemy or Tortoise).

Project description

robyn-config

robyn-config is a small CLI that scaffolds Robyn backend projects from the bundled templates. It can generate either DDD or MVC layouts and swaps between SQLAlchemy and Tortoise implementations on demand.

Installation

pip install .
# or
uv tool install .

Usage

Create a project with your preferred ORM and architecture:

robyn-config create my-service --orm sqlalchemy --design ddd ./my-service
robyn-config create newsletter --orm tortoise --design mvc ~/projects/newsletter

Options:

  • name sets the project name used in templated files like pyproject.toml and README.md.
  • --orm (sqlalchemy|tortoise) selects the database layer.
  • --design (ddd|mvc) toggles between the Domain-Driven and MVC templates.
  • destination is the target directory (defaults to .); if it is not empty, you will be prompted before overwriting conflicts.

The command copies:

  • Common project files (docker-compose, Makefile, env templates, README, pyproject, uv.lock).
  • Application code from src/app_ddd or src/app_mvc into src/app.
  • Compose helpers from src/common/compose/app with ORM-specific dev/prod runners.
  • For Tortoise projects, Alembic artifacts are omitted from the Docker image.

Template contents

The shipped templates live alongside the CLI:

  • Root-level files sit under src/common.
  • Compose files are under src/common/compose/app.
  • Application code is under src/ddd and src/mvc.

Feel free to modify these in-place to customize the generated projects.

Development

Run the linters/tests locally:

uv venv && source .venv/bin/activate
uv pip install -e .[dev]
ruff check src
pytest

Build a wheel for distribution:

python -m build

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robyn_config-0.1.1.tar.gz (128.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

robyn_config-0.1.1-py3-none-any.whl (159.2 kB view details)

Uploaded Python 3

File details

Details for the file robyn_config-0.1.1.tar.gz.

File metadata

  • Download URL: robyn_config-0.1.1.tar.gz
  • Upload date:
  • Size: 128.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for robyn_config-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0d603d8a3f6e18fefd8351ef50a93b52de11786f9d09b703a5d8660e33327ebb
MD5 03111b69e9ccf8e145a3a4518dfcbcc8
BLAKE2b-256 34954a7046d692ccac97474db52786e8c45673e836890091601cbac04756feb2

See more details on using hashes here.

Provenance

The following attestation bundles were made for robyn_config-0.1.1.tar.gz:

Publisher: python-publish.yml on Lehsqa/robyn-config

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file robyn_config-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: robyn_config-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 159.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for robyn_config-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 84cf91c168177df68a8c0de85a3ceef37a54ab92034be6c258576ac14200a048
MD5 c836a2503b1ee1aaea77ed850bbbc7ee
BLAKE2b-256 e51fde14e43098417fa16bbf34b3ba432e71f829f916b4b586bae86ba51c3a29

See more details on using hashes here.

Provenance

The following attestation bundles were made for robyn_config-0.1.1-py3-none-any.whl:

Publisher: python-publish.yml on Lehsqa/robyn-config

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page