pyforge-init 0.1.0__py3-none-any.whl

pyforge_init-0.1.0.dist-info/METADATA

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: pyforge-init
+Version: 0.1.0
+Summary: A CLI tool to scaffold new Python projects, similar to create-react-app.
+Author-email: Your Name <your.email@example.com>
+Requires-Python: >=3.9
+Requires-Dist: click>=8.0.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: questionary>=2.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: tomli>=2.0.0; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: pytest-mock>=3.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pyforge
+
+`pyforge` is a lightweight, interactive command-line interface (CLI) tool designed to scaffold production-ready Python projects in seconds. Inspired by standard scaffolding tools, `pyforge` automates project initialization, environment setup, testing configuration, linting, formatting, and dependency management.
+
+---
+
+## Key Features
+
+* **Interactive TUI**: Driven by `questionary` for guided project configuration (supports non-interactive overrides).
+* **Multiple Built-in Templates**: Native templates for `basic` packages, `cli` tools, `fastapi` microservices, and `flask` applications.
+* **Remote Templates**: Pull custom project layouts directly from public GitHub repositories using the `gh:owner/repo` syntax.
+* **Configurable Defaults**: Save persistent author, license, and tool choices in a `~/.newpythonrc` configuration file.
+* **Standards-Compliant**: Generates PEP 621-compliant `pyproject.toml` using `hatchling` as the build backend.
+* **Tooling Configuration**: Preconfigured integration with `pytest`, `ruff` (linter and formatter), and `pre-commit` hooks.
+* **Task Automation**: Automated creation of a local virtual environment, Git repository initialization, and generation of a template-aware `Makefile` or `Justfile`.
+
+---
+
+## Installation
+
+Install `pyforge-init` globally via PyPI:
+
+```bash
+pip install pyforge-init
+```
+
+Or install it in an isolated environment using `pipx`:
+
+```bash
+pipx install pyforge-init
+```
+
+---
+
+## Quick Start
+
+Initialize a new project by running:
+
+```bash
+newpython myproject
+```
+
+The CLI will start the interactive configuration wizard:
+
+```
+? Project description: A new Python project
+? Author name: Jane Doe
+? License: MIT
+? Initialize a virtual environment (.venv)? Yes
+? Initialize a git repository? Yes
+```
+
+Once the wizard completes, your project directory is created and populated. Execute the following commands to begin development:
+
+```bash
+cd myproject
+source .venv/bin/activate    # On Windows use: .venv\Scripts\activate
+make install                 # Installs the package and all dev dependencies
+make run                     # Runs the application (varies by template)
+```
+
+---
+
+## CLI Reference
+
+```
+Usage: newpython [OPTIONS] PROJECT_NAME
+
+  Scaffold a new Python project.
+
+Arguments:
+  PROJECT_NAME  Name of the project (must be a valid Python identifier)
+
+Options:
+  --template TEXT      Built-in template (basic, cli, fastapi, flask)
+                       or a remote GitHub repo (gh:owner/repo[@ref]) [default: basic]
+  --no-pre-commit      Skip generating .pre-commit-config.yaml
+  --justfile           Generate a Justfile instead of a Makefile
+  -y, --yes            Skip interactive prompts and accept defaults
+  --help               Show this message and exit.
+```
+
+---
+
+## Project Structure (Basic Template)
+
+The default template (`basic`) generates the following directory structure:
+
+```
+myproject/
+├── src/
+│   └── myproject/
+│       └── __init__.py          # Package initialization
+├── tests/
+│   └── test_main.py             # Starter unit test
+├── .env.example                 # Example environment variables
+├── .gitignore                   # Standard Python git ignore rules
+├── .pre-commit-config.yaml      # Pre-configured linting/formatting hooks
+├── Makefile                     # Task runner
+├── README.md                    # Generated project documentation
+├── pyproject.toml               # Metadata, dependencies, and tool settings
+└── requirements.txt             # Project dependencies
+```
+
+---
+
+## Templates
+
+### Built-in Templates
+
+| Template | Primary Stack | Generated Entry Point | Run Command |
+|---|---|---|---|
+| `basic` | Pure Python | `src/package/__init__.py` | `python -m package` |
+| `cli` | `click` | `src/package/cli.py` & `__main__.py` | Registered console script |
+| `fastapi` | `fastapi`, `uvicorn`, `httpx` | `src/package/main.py` | `uvicorn src.package.main:app` |
+| `flask` | `flask` (Factory pattern) | `src/package/app.py` | `flask run` |
+
+### Remote Templates
+
+You can import any public GitHub repository to use as a project template:
+
+```bash
+# Uses the main/master branch
+newpython myproject --template gh:username/repo-name
+
+# Pin to a specific branch, tag, or commit hash
+newpython myproject --template gh:username/repo-name@v1.0.0
+```
+
+#### Remote Repository Requirements
+Remote templates are fetched and copied as-is (no Jinja template rendering is performed on remote files). 
+* If the remote repository has a top-level `template/` directory, only the contents of that folder are copied to the destination.
+* If no `template/` directory is present, the entire contents of the repository root will be copied.
+
+---
+
+## Configuration File (`~/.newpythonrc`)
+
+You can persist configuration defaults in a `~/.newpythonrc` (TOML format) file to pre-fill prompt values and skip entering them on every run.
+
+```toml
+# ~/.newpythonrc
+author = "Jane Doe"
+license = "MIT"
+template = "basic"
+pre_commit = true
+justfile = false
+```
+
+### Precedence Order
+When resolving configurations, `pyforge` applies overrides in the following order (highest to lowest):
+1. **CLI Flags** (e.g. `--template`, `--justfile`)
+2. **Configuration file** (`~/.newpythonrc`)
+3. **Interactive Prompt Defaults**
+
+To override the default config location, set the `NEWPYTHON_CONFIG` environment variable:
+```bash
+export NEWPYTHON_CONFIG="/path/to/custom/config.toml"
+```
+
+---
+
+## Automated Task Runner
+
+The generated `Makefile` (or `Justfile` if `--justfile` is passed) exposes standard commands for project maintenance:
+
+* `make install`: Installs the project locally in editable mode alongside all development dependencies (`pip install -e ".[dev]"`).
+* `make test`: Executes the test suite using `pytest`.
+* `make lint`: Performs static analysis checking with `ruff`.
+* `make format`: Auto-formats code styles using `ruff format`.
+* `make run`: Starts the application server or CLI script (template-aware).
+* `make clean`: Recursively cleans local cache directories (`__pycache__`, `.pytest_cache`, `.ruff_cache`, `build`, `dist`).
+
+---
+
+## Publishing to PyPI
+
+Projects generated by `pyforge` use `hatchling` as the build system and are ready to be built and uploaded to PyPI:
+
+1. Install build and publication dependencies:
+   ```bash
+   pip install build twine
+   ```
+2. Build the project distribution packages (source archive and wheel):
+   ```bash
+   python -m build
+   ```
+3. Upload to PyPI (or TestPyPI first):
+   ```bash
+   python -m twine upload dist/*
+   ```
+
+---
+
+## Contributing
+
+Contributions to `pyforge` are welcome. To set up a local development environment:
+
+```bash
+git clone https://github.com/your-name/pyforge.git
+cd pyforge
+pip install -e ".[dev]"
+python -m pytest -v
+```

pyforge_init-0.1.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+pyforge/__init__.py,sha256=cByAUJAaGo8zE4nISvOJR_8JBORLOfE0CtE2nT5HtW8,65
+pyforge/cli.py,sha256=n-BtHvmkpdR46TjsKUf7u2OeteN1-4wD7hY3ELXybNY,7120
+pyforge/config.py,sha256=KHLWmrWUDtAvLieJI7fH6zEKcy9XLe_SbvgkZTBRklg,3574
+pyforge/generator.py,sha256=WgM4c1rdt2o9ofYVMGlD2DKdootz9rHtufSTHXe_TnM,5985
+pyforge/prompts.py,sha256=Zo9tPjJRGqQhENdMoEroJn6RbCmbR8sBxQNs2Y3IdAM,6095
+pyforge/remote.py,sha256=EfvavkpWbeDnumgoTjRfLqPAb3A6wKu1gdD4piyNCUY,6041
+pyforge/utils.py,sha256=2jjaHc1KeoqRD_W3qAYtm6TfPJO7bBqYgXRST4WYDG4,1973
+pyforge/templates/basic/tests/test_main.py.jinja,sha256=1Z659NQdKdN6JRgugwHeFyOmicszqYEEIC60-0kgumw,79
+pyforge/templates/cli/src/package/__main__.py.jinja,sha256=y5WriDGWdwrXKv5igEd5MltM3hKaFq6VZTPxD7oAeXY,79
+pyforge/templates/cli/src/package/cli.py.jinja,sha256=xtR8iPXJpiwwz4mvBpY0TAnB9SUjgi0G3lhJYowvkyA,182
+pyforge/templates/cli/tests/test_cli.py.jinja,sha256=__qCaJ-SaSuubFj7OpEMuUvlzSkns1B8nfSlNR-nHcQ,248
+pyforge/templates/fastapi/src/package/main.py.jinja,sha256=GChD5xohSCN-MOLOUR5JFydS__IpjMCC_09OJyjYCak,143
+pyforge/templates/fastapi/tests/test_main.py.jinja,sha256=HwG61zwgEFwSgDHK4GIPM59wchwpxcrNgD-NTtOpGGc,260
+pyforge/templates/flask/src/package/app.py.jinja,sha256=Ryx8UGf8EbH9G_EriOOfZY9swu22aamM0DV1N5heK4U,167
+pyforge/templates/flask/tests/test_app.py.jinja,sha256=IcJ5YFvH1M5Moko9HiP6VXrtMI18tr8NviN4iV2z5sM,396
+pyforge/templates/shared/Justfile.jinja,sha256=28X37B0jvgwi3yB2i8q0I-5oquqIuyrAGJ1JDsPwsJw,605
+pyforge/templates/shared/Makefile.jinja,sha256=DxfxIKQw5Lnytq2iX-ZkQszWk5lwSTx9Ai8bi3CZNZo,613
+pyforge/templates/shared/README.md.jinja,sha256=ltieQX-L7e9uSscVhTN4qxJ3yhTaoZTMkQgj0ahpRvc,474
+pyforge/templates/shared/env.example.jinja,sha256=prkabCyzO2_YL5AWFm9AQpfvTxmb18lspPSaHvNhWhA,211
+pyforge/templates/shared/gitignore.jinja,sha256=jCGyE4uk6GUSfwTJw0lK2dplb6v7cKaar5VbXwH6MUU,115
+pyforge/templates/shared/pre-commit-config.yaml.jinja,sha256=Z55GQtZtAKGW05msYtrCrUhD-DmXO63t73QdfnqteiQ,382
+pyforge/templates/shared/pyproject.toml.jinja,sha256=pYnlYm_G-QfdhldE0592KIwG870ocHvn5chh2otEzac,1067
+pyforge/templates/shared/requirements.txt.jinja,sha256=u8_CUdsIpkFibfCXwv-Ca_YMo3Q7gWZAYSnDVancw_I,37
+pyforge/templates/shared/src/package/__init__.py.jinja,sha256=VRdil8MpsJxZrevfQsOK_fKvalf8kJmld74ttLKOzew,27
+pyforge_init-0.1.0.dist-info/METADATA,sha256=VQukOhMklSPjFs9q8GVaUoMC79u1S42_h9Oigxiag0o,7346
+pyforge_init-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+pyforge_init-0.1.0.dist-info/entry_points.txt,sha256=Jxhn-m0OgG3Hgz80byUqEeApRpM2B6O1f-hDYl03mtE,47
+pyforge_init-0.1.0.dist-info/RECORD,,

pyforge_init-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

pyforge_init-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+newpython = pyforge.cli:main