{"id":31833531,"url":"https://github.com/pythonhubdev/scaffoldr","last_synced_at":"2025-10-11T23:56:15.329Z","repository":{"id":61060928,"uuid":"544126665","full_name":"pythonhubdev/scaffoldr","owner":"pythonhubdev","description":"Modern Python web framework project generator with production-ready architecture.","archived":false,"fork":false,"pushed_at":"2025-10-06T15:08:40.000Z","size":516,"stargazers_count":2,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-09T00:05:21.754Z","etag":null,"topics":["fastapi","flask","flask-application","litestar","pydantic","python","quartz","sql","sqlalchemy","sqlmodel"],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pythonhubdev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-10-01T18:05:16.000Z","updated_at":"2025-09-28T13:54:01.000Z","dependencies_parsed_at":"2025-09-27T02:18:55.495Z","dependency_job_id":null,"html_url":"https://github.com/pythonhubdev/scaffoldr","commit_stats":null,"previous_names":["quantivio/faag_cli","devzonecommunity/faag_cli","pythonhubdev/faag_cli"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/pythonhubdev/scaffoldr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fscaffoldr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fscaffoldr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fscaffoldr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fscaffoldr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pythonhubdev","download_url":"https://codeload.github.com/pythonhubdev/scaffoldr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pythonhubdev%2Fscaffoldr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279009365,"owners_count":26084582,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastapi","flask","flask-application","litestar","pydantic","python","quartz","sql","sqlalchemy","sqlmodel"],"created_at":"2025-10-11T23:55:57.389Z","updated_at":"2025-10-11T23:56:15.321Z","avatar_url":"https://github.com/pythonhubdev.png","language":"Jinja","readme":"# Scaffoldr\n\n\u003e Previously this package was known as `faag-cli` now renamed to `scaffoldr`.\n\n**Modern Python web framework project generator with production-ready architecture.**\n\nScaffoldr is a command-line toolkit that rapidly scaffolds full-featured Python web projects using modern best\npractices. Pick a template, and Scaffoldr creates a consistent, opinionated project layout with sensible defaults for\npackaging, configuration, testing, OpenAPI docs, and containerized deployments — all designed to be easy to extend and\nmaintain.\n\nIt accelerates day-one productivity by removing repetitive setup work: boilerplate routes, dependency management,\nlinting, unit-test scaffolds, CI pipeline stubs, and a ready-to-run Docker configuration are included out of the box.\nTemplates are pluggable, letting teams standardize on their preferred frameworks and conventions while keeping the setup\nfast and repeatable.\n\n[![Python 3.13+](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n\n## ✨ Features\n\n- 🚀 **Multiple Framework Support**: FastAPI, Flask, Litestar, BlackSheep, Robyn (coming soon)\n- 🏗️ **Production-Ready Architecture**: Feature-driven design with clear separation of concerns\n- 📦 **Modern Tooling**: Built with `uv` package manager, `ruff` for linting, and `typer` for CLI\n- 🔧 **Automated Setup**: Pre-configured development environment with testing, linting, and pre-commit hooks\n- 📝 **Best Practices**: Follows industry standards and patterns for maintainable code\n- 🎯 **Extensible**: Easy to add new frameworks and customize generated projects\n\n## 📋 Requirements\n\n- **Python 3.13+**\n- **uv** package manager\n\n## 🚀 Quick Start\n\n### Installation\n\n```bash\n# Install from PyPI (coming soon)\npip install scaffoldr\n\n# Or install with uv\nuv add scaffoldr\n\n# Or install from source\ngit clone https://github.com/pythonhubdev/scaffoldr.git\ncd scaffoldr\nuv sync\n```\n\n### Usage\n\n```bash\n# Generate a new FastAPI project (default)\nscaffoldr generate my-api\n\n# Generate with specific framework\nscaffoldr generate my-api --framework fastapi\n\n# Get help\nscaffoldr --help\nscaffoldr generate --help\n\n# Disable the animated banner\nscaffoldr --no-banner generate my-project\n```\n\n### Generated Project Features\n\nWhen you generate a FastAPI project, you get:\n\n- **Complete FastAPI Application**: Pre-configured with proper structure\n- **Database Integration**: SQLAlchemy with Alembic migrations or MongoDB with Beanie ODM\n- **File Storage**: Built-in file upload/download endpoints\n- **API Documentation**: Auto-generated OpenAPI/Swagger docs\n- **Development Tools**: Pre-configured with ruff, mypy, pytest\n- **Docker Support**: Ready-to-use Docker configuration\n- **Environment Management**: .env support with validation\n- **Logging**: Structured logging with proper middleware\n- **Error Handling**: Comprehensive exception handling\n- **Testing**: Test structure with fixtures and examples\n\n### ✨ Animated Banner\n\nScaffoldr features a beautiful animated ASCII banner with rainbow wave effects that displays when you run the CLI! The\nbanner showcases the \"SCAFFOLDR\" logo with:\n\n- 🌈 **Rainbow color cycling** - Dynamic HSL color transitions\n- 🌊 **Wave animations** - Smooth sine wave effects across the text\n- ⚡ **High frame rate** - Smooth 15 FPS animations for 3 seconds\n- 🎨 **Gradient finale** - Beautiful blue-to-purple gradient after animation\n- 🚫 **Optional disable** - Use `--no-banner` to skip the animation\n\nThe banner is inspired by GitHub Copilot CLI and adds a delightful touch to your scaffolding experience!\n\n## 🏗️ Supported Frameworks\n\n| Framework      | Status         | Description                            |\n|----------------|----------------|----------------------------------------|\n| **FastAPI**    | ✅ Available    | Modern, high-performance web framework |\n| **Flask**      | 🚧 Coming Soon | Lightweight and flexible web framework |\n| **Litestar**   | 🚧 Planned     | High-performance ASGI web framework    |\n| **BlackSheep** | 🚧 Planned     | Fast ASGI web framework                |\n| **Robyn**      | 🚧 Planned     | Rust-powered Python web framework      |\n\n## 📁 Generated Project Structure\n\nScaffoldr generates projects with a clean, scalable architecture:\n\n```\nmy-project/\n├── src/\n│   └── backend/\n│       ├── api/                # API layer configuration\n│       ├── core/               # Core components (config, utils, etc.)\n│       ├── features/           # Feature modules (business logic)\n│       ├── services/           # External service integrations\n{% if database %}\n│       └── database/           # Data access layer (SQLAlchemy or MongoDB)\n{% endif %}\n├── tests/                      # Comprehensive test suite\n├── scripts/                    # Development scripts\n├── .github/                    # GitHub workflows and templates\n├── pyproject.toml              # Project configuration\n├── Taskfile.yaml              # Task automation\n└── README.md                   # Project documentation\n```\n\n## 🛠️ Development\n\n### Prerequisites\n\n- Python 3.13+\n- [Task](https://taskfile.dev/) (optional, for automated commands)\n\n### Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/pythonhubdev/scaffoldr.git\ncd scaffoldr\n\n# One-shot setup (installs uv, syncs deps, sets up pre-commit)\ntask setup\n\n# Or manually:\n# Install uv if not present\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n\n# Install dependencies\nuv sync --all-extras\n\n# Install pre-commit hooks\nuv run pre-commit install\n```\n\n### Available Commands\n\n```bash\n# Development\ntask setup          # Complete project bootstrap\ntask deps           # Sync dependencies\ntask pre-commit     # Run pre-commit hooks\n\n# Code Quality\ntask lint           # Run linters and formatters\ntask test           # Run tests with coverage\ntask test-u         # Run unit tests only\n\n# Cleanup\ntask pycache        # Remove Python cache files\ntask ds-store       # Remove .DS_Store files\n```\n\n### Project Philosophy\n\nScaffoldr follows these principles:\n\n1. **Developer Experience First**: Minimize setup time, maximize productivity\n2. **Modern Tooling**: Use the best tools available in the Python ecosystem\n3. **Production Ready**: Generated projects should be deployment-ready\n4. **Extensible**: Easy to add new frameworks and customize templates\n5. **Community Driven**: Built for and by the Python community\n\n## 🤝 Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\n\n### Quick Contribution Steps\n\n1. Fork the repository\n2. Create a feature branch: `git checkout -b feature/amazing-feature`\n3. Make your changes\n4. Run tests: `task test`\n5. Run linting: `task lint`\n6. Commit your changes: `git commit -m 'Add amazing feature'`\n7. Push to the branch: `git push origin feature/amazing-feature`\n8. Open a Pull Request\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\n- Built with [Typer](https://typer.tiangolo.com/) for the CLI interface\n- Uses [uv](https://github.com/astral-sh/uv) for fast Python package management\n- Code quality maintained with [Ruff](https://github.com/astral-sh/ruff)\n\n## 📞 Support\n\n- 🐛 [Report Issues](https://github.com/pythonhubdev/scaffoldr/issues)\n- 💡 [Request Features](https://github.com/pythonhubdev/scaffoldr/issues/new?template=feature_request.md)\n- 📖 [Documentation](https://github.com/pythonhubdev/scaffoldr/wiki)\n\n---\n\n**Scaffoldr** - *Building better Python projects, faster.*\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonhubdev%2Fscaffoldr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpythonhubdev%2Fscaffoldr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythonhubdev%2Fscaffoldr/lists"}