rpr-cli 0.1.6__tar.gz → 0.1.7__tar.gz

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rpr-cli
-Version: 0.1.6
+Version: 0.1.7
 Summary: RPR CLI -- React Python Rust monorepo scaffolding orchestrator
 License-Expression: MIT
 License-File: LICENSE

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/Sample-dot-github/instructions/frontend.instructions.md

@@ -84,7 +84,7 @@ export const SomeContainer = styled(Box)`
 
 - Type every API payload and mutation input.
 - Prefer `type` aliases for DTO-shaped data, `interface` for extendable service contracts, and classes only when the UI genuinely needs behavior.
-- For components with children, prefer `React.PropsWithChildren<T>` over manually re-declaring a `children` field.
+- For components with children, prefer `React.PropsWithChildren<T>` over manually redeclaring a `children` field.
 
 ## Components
 

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/nx_uv_setup.md

@@ -1,8 +1,8 @@
 # NX + UV Monorepo Setup Guide
 
-This guide explains how to setup a monorepo that cobines NX ( for Node / Typescript ) and UV (for Python).
+This guide explains how to set up a monorepo that combines NX (for Node / TypeScript) and UV (for Python).
 
-## Rprerequisites
+## Prerequisites
 
 Install the following:
 
@@ -10,30 +10,30 @@ Install the following:
 - **npm**: comes with Node.js
 - **UV**: install from [uv.io](https://uv.io/)
 - **Python**: latest version from [python.org](https://www.python.org/)
-- **GIT**: latest version from [git-scm.com](https://git-scm.com/)
-- **Rust**: latest version from [rust-lang.org](https://www.rust-lang.org/)(optional, for Rust-based engines)
+- **Git**: latest version from [git-scm.com](https://git-scm.com/)
+- **Rust**: latest version from [rust-lang.org](https://www.rust-lang.org/) (optional, for Rust-based engines)
 
 ## Initial Setup
 
 ### Step 1: Create NX Workspace
 
 ```shell
-npx create-nx-workspace@latest my-monorepo --template=nrwl/empty-template
+npx create-nx-workspace@latest my-monorepo --preset=apps --nxCloud=never --interactive=false
 cd my-monorepo
 ```
 
 If you already have an existing directory, you can initialize NX in it:
 
 ```shell
-npx create-nx-workspace@latest . --template=nrwl/empty-template
+npx nx init --interactive=false --nxCloud=false
 ```
 
 ### Step 2: Initialize UV
 
-Create a root `pyproject.toml`file for UV workspace management
+Create a root `pyproject.toml` file for UV workspace management
 
 ```shell
-uv init --no-project
+uv init --no-readme --no-pin-python --python {python_version}
 ```
 
 Edit the generated `pyproject.toml` to include the following configuration:
@@ -140,7 +140,7 @@ npx nx g @nx/storybook:configuration {sb-name} --uiFramework=@storybook/react-vi
 
 ## Adding Python Projects
 
-Python project require manual setup since NX doesn't have build int Python plugins.
+Python projects require manual setup since NX doesn't have built-in Python plugins.
 
 ### Step 1: Create Directory Structure
 
@@ -170,7 +170,7 @@ requires-python = ">={python_version}"
 dependencies = []
 
 [tool.uv]
-require-version=">={uv_version}" # use the latest you have installed
+required-version = ">={uv_version}" # use the latest you have installed
 
 [tool.uv.workspace]
 members = [
@@ -190,8 +190,8 @@ dev = [
 ]
 [tool.ruff]
 line-length = 88
-target-version="py314" # Update to match your target Python version
-exclude = [**/migrations/**]
+target-version = "py314" # Update to match your target Python version
+exclude = ["**/migrations/**"]
 
 [tool.ruff.lint]
 select = [
@@ -207,17 +207,17 @@ ignore = [
     "C901" # Complexity, can be handled by refactoring when needed, but not a hard rule
 ]
 
-[tool.ruff.lint.pre-file-ignores]
-"__init"__.py" = [
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = [
     "F401", # Allow unused imports in __init__.py for package exports
 ]
-"tests/"=["F841"]
+"tests/**/*.py" = ["F841"]
 
 [tool.ruff.format]
-quote-style="double"
-indent-style="space"
-skip-magic-trailing-comma=false
-line-ending="lf"
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "lf"
 
 [tool.pytest.ini_options]
 pythonpath = [
@@ -230,7 +230,7 @@ testpaths = [
 ]
 ```
 
-**For a fast api application (`apps/{my-python-app}/pyproject.toml`)**
+**For a FastAPI application (`apps/{my-python-app}/pyproject.toml`)**
 
 ```toml
 [project]
@@ -245,13 +245,8 @@ dependencies = [
     # Add other workspace dependencies here e.g. "{my-python-lib}" must be defined in tool.uv.sources
 ]
 
-[tool.uv.workspace]
-members = [
-    "apps/{my-python-app}"
-]
-
 [tool.uv.sources]
-{my-python-lib} = { workspace = true }
+"{my-python-lib}" = { workspace = true }
 
 [project.optional-dependencies]
 dev = [
@@ -263,11 +258,11 @@ dev = [
 ]
 
 [build-system]
-requires=["hatchling"]
-build-backend="hatchling.build"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
-[tool.hatch.build.targets.wheel.force-include]
-"src"="{my_python_app}"
+[tool.hatch.build.targets.wheel]
+packages = ["src/{my_python_app}"]
 
 [tool.coverage.run]
 source = ["src"]
@@ -279,8 +274,8 @@ omit = [
     "*/.venv/*"
 ]
 
-[tool.coverage.report]
-output="coverage.xml"
+[tool.coverage.xml]
+output = "coverage.xml"
 
 [tool.coverage.report]
 exclude_lines = [
@@ -313,10 +308,10 @@ dependencies = []
 # another-lib = { workspace = true }
 
 [build-system]
-requires=["hatchling"]
-build-backend="hatchling.build"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
-[tool.hatch.build.targets.wheel.force-include]
+[tool.hatch.build.targets.wheel]
 packages = ["src/{my_python_lib}"]
 
 # if you have files that are not code like json or yaml you can include them in the wheel with:
@@ -497,7 +492,7 @@ Alembic autogeneration relies on model discovery, make sure the new entity modul
 
 ## Adding other languages (e.g. Rust)
 
-The same pattern can be applied to other languages. Here how you would setup a Rust project:
+The same pattern can be applied to other languages. Here is how you would set up a Rust project:
 
 ### Step 1: Create Directory Structure
 
@@ -646,7 +641,7 @@ Example:
 - Use `.env.example` to document required environment variables without exposing sensitive information
 - Never commit `.env` files to version control
 - For python use `python-dotenv` or `pydantic-settings` to load environment variables in your application
-- For Node.js ise `dotenv` or Vite's built-in environment variable support
+- For Node.js use `dotenv` or Vite's built-in environment variable support
 
 ### 6. Testing
 
@@ -710,7 +705,7 @@ repos:
 
       - id: prettier
         name: Prettier format
-        entry: npx prettier --write --loglevel=warn
+        entry: npx prettier --write --log-level=warn
         language: system
         types_or: [javascript, jsx, ts, tsx, json, css, scss, html, markdown]
         exclude: \.ipynb$ # Exclude Jupyter notebooks from Prettier formatting
@@ -726,7 +721,7 @@ repos:
 
 ### 9. CI / CD Considerations
 
-- Use NX's aggected commands to only test/build changed projects
+- Use NX's affected commands to only test/build changed projects
 - Cache build between CI runs
 - Example GitHub Actions:
 
@@ -815,7 +810,7 @@ uvx ruff format . # Format Python code with Ruff
 **Problem:**
 
 1. The package is not listed in the root `pyproject.toml` under `[tool.uv.workspace].members`
-2. You have not ran `uv sync --all-packages` after adding the package to the workspace configuration
+2. You have not run `uv sync --all-packages` after adding the package to the workspace configuration
 3. The workspace dependency was not declared with `{ workspace = true }` in the `[tool.uv.sources]` section of the dependent package's `pyproject.toml`
 
 ### Issue: NX can't find Python projects
@@ -838,7 +833,7 @@ uvx ruff format . # Format Python code with Ruff
 
 This setup gives you the best of both worlds:
 
-- **NX** for Node.js/Typescript projects with excellent tooling and generators
+- **NX** for Node.js/TypeScript projects with excellent tooling and generators
 - **UV** for Python projects with modern dependency management and workspace support
 - A unified monorepo structure that allows you to manage both ecosystems in one place.
 - Extensible to other languages like Rust with manual setup.

rpr_cli-0.1.7/src/rpr/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.7"

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/src/rpr/checks/workspace.py

@@ -73,7 +73,7 @@ def check_workspace(project_dir: Path) -> list[CheckResult]:
     pytest_config = False
     dev_dependencies_ok = False
     if tool:
-        uv_require_version = "require-version" in tool.get("uv", {})
+        uv_require_version = "required-version" in tool.get("uv", {})
         pytest_config = "pytest" in tool and "ini_options" in tool["pytest"]
 
     dependency_groups = pyproject_data.get("dependency-groups", {}) if pyproject_data else {}

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/src/rpr/commands/generate/api.py

@@ -42,6 +42,7 @@ def api(
     ctx.ensure_dir(tests_root)
 
     _write_api_pyproject(ctx, api_root, name, app_name, app_name_underscore)
+    _write_api_readme(ctx, api_root, name)
     _write_api_project_json(ctx, api_root, app_name, app_name_underscore)
     _write_main(ctx, src_root / "main.py", name, domain_underscore)
     _write_init_file(ctx, src_root / "__init__.py")
@@ -98,6 +99,14 @@ testpaths = ["tests"]
     ctx.write_file(api_root / "pyproject.toml", content)
 
 
+def _write_api_readme(ctx: RunContext, api_root: Path, name: str) -> None:
+    content = f"""# {name} API
+
+FastAPI application generated by RPR.
+"""
+    ctx.write_file(api_root / "README.md", content)
+
+
 def _write_api_project_json(
     ctx: RunContext, api_root: Path, app_name: str, app_name_underscore: str
 ) -> None:

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/src/rpr/commands/generate/domain.py

@@ -60,6 +60,7 @@ def domain(
 
     # --- project metadata --------------------------------------------------
     _write_domain_pyproject(ctx, domain_root, name, pkg_name_underscore)
+    _write_domain_readme(ctx, domain_root, name)
     _write_project_json(ctx, domain_root, include_migrations=migrations)
 
     # --- __init__.py files -------------------------------------------------
@@ -142,6 +143,14 @@ testpaths = ["tests"]
     ctx.write_file(domain_root / "pyproject.toml", content)
 
 
+def _write_domain_readme(ctx: RunContext, domain_root: Path, name: str) -> None:
+    content = f"""# {name} Domain
+
+Domain layer package generated by RPR.
+"""
+    ctx.write_file(domain_root / "README.md", content)
+
+
 def _write_project_json(
     ctx: RunContext, domain_root: Path, *, include_migrations: bool
 ) -> None:

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/src/rpr/commands/init.py

@@ -355,7 +355,7 @@ requires-python = ">={python_version}"
 dependencies = []
 
 [tool.uv]
-require-version = "{uv_require_version}"
+required-version = "{uv_require_version}"
 
 [tool.uv.workspace]
 members = []
@@ -398,6 +398,18 @@ testpaths = []
     ctx.update_file(ctx.project_dir / "pyproject.toml", content)
 
 
+def _write_root_readme(ctx: RunContext, project_name: str) -> None:
+    path = ctx.project_dir / "README.md"
+    if path.exists():
+        return
+
+    content = f"""# {project_name}
+
+RPR NX + UV monorepo.
+"""
+    ctx.write_file(path, content)
+
+
 def _detect_uv_require_version() -> str:
     try:
         result = subprocess.run(
@@ -813,6 +825,7 @@ def init(
     # ------------------------------------------------------------------
     _write_nx_json(ctx)
     _write_root_pyproject(ctx, project_name, python_version)
+    _write_root_readme(ctx, project_name)
     _write_root_package_json(ctx, project_name)
     _write_tsconfig_base(ctx)
     _write_root_eslint_config(ctx)

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/src/rpr/scaffolds/instructions/frontend.instructions.md

@@ -96,7 +96,7 @@ export const SomeContainer = styled(Box)`
 
 - Type every API payload and mutation input.
 - Prefer `type` aliases for DTO-shaped data, `interface` for extendable service contracts, and classes only when the UI genuinely needs behavior.
-- For components with children, prefer `React.PropsWithChildren<T>` over manually re-declaring a `children` field.
+- For components with children, prefer `React.PropsWithChildren<T>` over manually redeclaring a `children` field.
 
 ## Components
 

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/tests/test_check.py

@@ -39,7 +39,7 @@ requires-python = ">=3.12"
 dependencies = []
 
 [tool.uv]
-require-version = ">=0.8.0"
+required-version = ">=0.8.0"
 
 [tool.uv.workspace]
 members = ["packages/python/domain", "apps/my-app-api"]

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/tests/test_generate_api.py

@@ -59,6 +59,7 @@ def test_generate_api_scaffolds_src_layout_tests_and_build_target(monkeypatch):
         assert (src_root / "__init__.py").exists()
         assert (src_root / "routes" / "__init__.py").exists()
         assert (tests_root / "test_health.py").exists()
+        assert (api_root / "README.md").read_text().startswith("# my-app API")
 
         pyproject = (api_root / "pyproject.toml").read_text()
         project = json.loads((api_root / "project.json").read_text())
@@ -67,6 +68,7 @@ def test_generate_api_scaffolds_src_layout_tests_and_build_target(monkeypatch):
         root_pyproject = Path("pyproject.toml").read_text()
 
         assert 'packages = ["src/my_app_api"]' in pyproject
+        assert 'readme = "README.md"' in pyproject
         assert '[tool.pytest.ini_options]' in pyproject
         assert 'testpaths = ["tests"]' in pyproject
         assert project["name"] == "my-app-api"

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/tests/test_generate_domain.py

@@ -68,6 +68,7 @@ def test_generate_domain_scaffolds_config_and_metadata(monkeypatch):
         assert (src_root / "entities" / "base.py").exists()
         assert (src_root / "repos" / "base.py").exists()
         assert (domain_root / "tests" / "test_package.py").exists()
+        assert (domain_root / "README.md").read_text().startswith("# my-app Domain")
 
         for package_dir in [
             "",
@@ -125,6 +126,7 @@ def test_generate_domain_scaffolds_config_and_metadata(monkeypatch):
         )
         assert "migrate" not in project["targets"]
         assert '[tool.pytest.ini_options]' in (domain_root / "pyproject.toml").read_text()
+        assert 'readme = "README.md"' in (domain_root / "pyproject.toml").read_text()
         assert 'members = ["packages/python/domain"]' in root_pyproject
 
         assert recorded_calls[0][0] == ["uv", "sync"]

{rpr_cli-0.1.6 → rpr_cli-0.1.7}/tests/test_init.py

@@ -56,7 +56,7 @@ def test_init_new_workspace_disables_nx_cloud(monkeypatch):
         assert 'name = "my-app"' in pyproject
         assert 'readme = "README.md"' in pyproject
         assert '[tool.uv]' in pyproject
-        assert 'require-version = ">=' in pyproject
+        assert 'required-version = ">=' in pyproject
         assert '"pytest-asyncio"' in pyproject
         assert '"pytest-cov"' in pyproject
         assert '"ipykernel"' in pyproject
@@ -90,6 +90,7 @@ def test_init_new_workspace_disables_nx_cloud(monkeypatch):
         assert (project_dir / ".prettierrc").exists()
         assert (project_dir / ".prettierignore").exists()
         assert (project_dir / ".pre-commit-config.yaml").exists()
+        assert (project_dir / "README.md").read_text().startswith("# my-app")
 
 
 def test_init_existing_workspace_disables_nx_cloud(monkeypatch):
@@ -132,8 +133,9 @@ def test_init_existing_workspace_disables_nx_cloud(monkeypatch):
         assert '"neverConnectToCloud": true' in nx_json
         assert '"plugin": "@nx/eslint/plugin"' in nx_json
         assert 'name = "my-app"' in pyproject
-        assert 'require-version = ">=' in pyproject
+        assert 'required-version = ">=' in pyproject
         assert 'testpaths = []' in pyproject
+        assert (project_dir / "README.md").read_text() == "existing"
         assert 'repo: https://github.com/pre-commit/pre-commit-hooks' in pre_commit
         assert 'repo: https://github.com/kynan/nbstripout' in pre_commit
         assert 'entry: npx nx run-many --target=lint --all --fix --exclude=engine' in pre_commit

rpr_cli-0.1.6/src/rpr/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.6"