forgeapi 0.1.0__tar.gz

forgeapi-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master, develop]
+  pull_request:
+    branches: [main, master, develop]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run linting
+        run: uv run ruff check .
+
+      - name: Run tests
+        run: uv run pytest -v --cov=fastapi_forge --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.11'
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Build package
+        run: uv build
+
+      - name: Check package
+        run: |
+          pip install twine
+          twine check dist/*

forgeapi-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,78 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      target:
+        description: "Target repository"
+        required: true
+        default: "testpypi"
+        type: choice
+        options:
+          - testpypi
+          - pypi
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    needs: build
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'testpypi'
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    needs: build
+    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'pypi')
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

forgeapi-0.1.0/.gitignore

@@ -0,0 +1,191 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+*.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/
+
+# 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
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# VS Code
+.vscode/
+
+# JetBrains IDEs
+.idea/
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+*.stackdump
+[Dd]esktop.ini
+$RECYCLE.BIN/
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+*.lnk
+
+# uv
+uv.lock
+
+# Ruff
+.ruff_cache/
+
+# Generated test projects
+test_output/

forgeapi-0.1.0/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial project structure with uv package management
+- Design document (DESIGN.md)
+- Development task tracking (TODO.md)
+- CLI framework with Typer and Rich terminal output
+- `forge version` and `forge create` commands
+- Interactive prompts with Questionary for project configuration
+- `ProjectConfig` Pydantic model with validation
+- `PackageManager` enum (uv, poetry, pip)
+- `DatabaseType` enum (postgres, mysql, sqlite, none)
+- Non-interactive mode support (`-y` / `--no-interactive` flag)
+- Jinja2 template engine for project generation (`generator.py`)
+- Complete base project templates:
+  - FastAPI application structure (api, core, services, daos, models, schemas)
+  - SQLAlchemy 2.0 async database configuration
+  - Alembic migration setup
+  - JWT authentication module
+  - Redis integration
+  - Docker and docker-compose configuration
+  - Pytest testing framework with conftest.py
+  - Ruff linter configuration
+  - GitHub Actions CI workflow
+  - VS Code configuration (settings, launch, extensions)
+- Unit tests for CLI, models, and generator (31 tests passing)
+
+## [0.1.0] - TBD
+
+### Added
+
+- CLI framework with Typer
+- Interactive project creation with Questionary
+- Support for uv, Poetry, and pip package managers
+- PostgreSQL, MySQL, and SQLite database templates
+- SQLAlchemy 2.0 async models
+- Alembic migration templates
+- JWT authentication module
+- Docker and docker-compose templates
+- Pytest testing framework templates
+- Ruff linter/formatter configuration
+- GitHub Actions CI template
+- VS Code configuration templates

forgeapi-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,242 @@
+# Contributing to ForgeAPI
+
+Thank you for your interest in contributing to ForgeAPI! 🎉
+
+## 📋 Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Making Changes](#making-changes)
+- [Testing](#testing)
+- [Submitting Changes](#submitting-changes)
+- [Style Guide](#style-guide)
+
+## Code of Conduct
+
+By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.
+
+## Getting Started
+
+1. **Fork the repository** on GitHub
+2. **Clone your fork** locally:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/forgeapi.git
+   cd forgeapi
+   ```
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.10 or higher
+- [uv](https://docs.astral.sh/uv/) (recommended)
+
+### Install Dependencies
+
+```bash
+# Install uv if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Create virtual environment and install dependencies
+uv sync --group dev
+
+# Activate the virtual environment
+source .venv/bin/activate
+
+# Verify installation
+forge version
+```
+
+### Project Structure
+
+```
+forgeapi/
+├── fastapi_forge/           # Main package
+│   ├── __init__.py
+│   ├── cli.py               # CLI entry point
+│   ├── commands/            # Command implementations
+│   ├── generator.py         # Template engine
+│   ├── models.py            # Data models
+│   ├── prompts.py           # Interactive prompts
+│   └── templates/           # Jinja2 templates
+├── tests/                   # Test suite
+├── pyproject.toml           # Project configuration
+├── DESIGN.md                # Design document
+├── TODO.md                  # Development tasks
+└── CHANGELOG.md             # Changelog
+```
+
+## Making Changes
+
+### Branch Naming
+
+Use descriptive branch names:
+
+- `feature/add-mongodb-support`
+- `fix/template-rendering-bug`
+- `docs/update-readme`
+- `refactor/simplify-generator`
+
+### Creating a Branch
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+### Commit Messages
+
+Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
+
+```
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+**Types:**
+
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `style`: Code style changes (formatting, etc.)
+- `refactor`: Code refactoring
+- `test`: Adding or updating tests
+- `chore`: Maintenance tasks
+
+**Examples:**
+
+```bash
+feat(generator): add MySQL support
+fix(cli): handle keyboard interrupt gracefully
+docs(readme): add installation instructions
+test(models): add ProjectConfig validation tests
+```
+
+## Testing
+
+### Running Tests
+
+```bash
+# Run all tests
+uv run pytest
+
+# Run with verbose output
+uv run pytest -v
+
+# Run specific test file
+uv run pytest tests/test_generator.py
+
+# Run with coverage report
+uv run pytest --cov=fastapi_forge --cov-report=html
+```
+
+### Writing Tests
+
+- Place tests in the `tests/` directory
+- Name test files as `test_*.py`
+- Use descriptive test function names: `test_should_generate_project_with_postgres`
+
+**Example Test:**
+
+```python
+import pytest
+from fastapi_forge.models import ProjectConfig, DatabaseType
+
+def test_project_config_generates_slug():
+    config = ProjectConfig(project_name="My Awesome API")
+    assert config.project_slug == "my_awesome_api"
+```
+
+## Submitting Changes
+
+### Before Submitting
+
+1. **Run tests** and ensure all pass:
+
+   ```bash
+   uv run pytest
+   ```
+
+2. **Run linting**:
+
+   ```bash
+   uv run ruff check .
+   uv run ruff format .
+   ```
+
+3. **Update documentation** if needed
+
+4. **Update CHANGELOG.md** with your changes
+
+### Pull Request Process
+
+1. **Push your branch** to your fork:
+
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+2. **Open a Pull Request** on GitHub
+
+3. **Fill out the PR template** with:
+   - Description of changes
+   - Related issue (if any)
+   - Screenshots (for UI changes)
+
+4. **Wait for review** - maintainers will review and provide feedback
+
+5. **Address feedback** and update your PR as needed
+
+## Style Guide
+
+### Python Code Style
+
+- Follow [PEP 8](https://pep8.org/)
+- Use [Ruff](https://docs.astral.sh/ruff/) for linting and formatting
+- Maximum line length: 120 characters
+- Use type hints for function signatures
+
+**Example:**
+
+```python
+from pathlib import Path
+
+def generate_project(
+    config: ProjectConfig,
+    output_dir: Path | None = None,
+) -> list[Path]:
+    """
+    Generate a FastAPI project from templates.
+
+    Args:
+        config: Project configuration
+        output_dir: Output directory (default: current directory)
+
+    Returns:
+        List of paths to generated files
+    """
+    ...
+```
+
+### Template Style
+
+- Use `.jinja` extension for template files
+- Use meaningful variable names
+- Add conditional blocks for optional features
+
+**Example:**
+
+```jinja
+{% if use_database %}
+from app.core.database import get_db
+{% endif %}
+```
+
+## 🙏 Thank You!
+
+Your contributions help make ForgeAPI better for everyone. We appreciate your time and effort!
+
+If you have any questions, feel free to open an issue or reach out to the maintainers.