FastAPI-fastkit 1.0.1__tar.gz → 1.1.0__tar.gz

fastapi_fastkit-1.1.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.1
+Name: FastAPI-fastkit
+Version: 1.1.0
+Summary: Fast, easy-to-use starter kit for new users of Python and FastAPI
+Author-Email: bnbong <bbbong9@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/bnbong/FastAPI-kit
+Project-URL: Repository, https://github.com/bnbong/FastAPI-kit
+Project-URL: Documentation, https://bnbong.github.io/FastAPI-fastkit/
+Project-URL: Changelog, https://bnbong.github.io/FastAPI-fastkit/changelog/
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1.7
+Requires-Dist: rich>=13.9.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.3; extra == "dev"
+Requires-Dist: pytest-cov>=6.2.1; extra == "dev"
+Requires-Dist: black>=24.10.0; extra == "dev"
+Requires-Dist: pre-commit>=4.0.1; extra == "dev"
+Requires-Dist: mypy>=1.12.0; extra == "dev"
+Requires-Dist: isort>=5.13.2; extra == "dev"
+Description-Content-Type: text/markdown
+
+<p align="center">
+    <img align="top" width="70%" src="https://bnbong.github.io/projects/img/fastkit_general_logo.png" alt="FastAPI-fastkit"/>
+</p>
+<p align="center">
+<em><b>FastAPI-fastkit</b>: Fast, easy-to-use starter kit for new users of Python and FastAPI</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi-fastkit" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi-fastkit" alt="PyPI - Version">
+</a>
+<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
+    <img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
+</a>
+</p>
+
+---
+
+This project was created to speed up the configuration of the development environment needed to develop Python-based web apps for new users of Python and [FastAPI](https://github.com/fastapi/fastapi).
+
+This project was inspired by the `SpringBoot initializer` & Python Django's `django-admin` cli operation.
+
+## Key Features
+
+- **⚡ Immediate FastAPI project creation** : Super-fast FastAPI workspace & project creation via CLI, inspired by `django-admin` feature of [Python Django](https://github.com/django/django)
+- **🎨 Prettier CLI outputs** : Beautiful CLI experience powered by [rich library](https://github.com/Textualize/rich)
+- **📋 Standards-based FastAPI project templates** : All FastAPI-fastkit templates are based on Python standards and FastAPI's common use patterns
+- **🔍 Automated template quality assurance** : Weekly automated testing ensures all templates remain functional and up-to-date
+- **🚀 Multiple project templates** : Choose from various pre-configured templates for different use cases (async CRUD, Docker, PostgreSQL, etc.)
+- **📦 Multiple package manager support** : Choose your preferred Python package manager (pip, uv, pdm, poetry) for dependency management
+
+## Installation
+
+Install `FastAPI-fastkit` at your Python environment.
+
+```console
+$ pip install FastAPI-fastkit
+```
+
+
+## Usage
+
+- Global options
+  - `--help`: Show help
+  - `--version`: Show version
+  - `--debug/--no-debug`: Toggle debug mode
+
+### Create a new FastAPI project
+```console
+fastkit init [OPTIONS]
+```
+- What it does: Scaffolds an empty FastAPI project, creates a virtual environment, installs dependencies
+- Key options:
+  - `--project-name`, `--author`, `--author-email`, `--description`
+  - `--package-manager` [pip|uv|pdm|poetry]
+  - Stack selection: `minimal` | `standard` | `full` (interactive)
+
+### Create a project from a template
+```console
+fastkit startdemo [TEMPLATE] [OPTIONS]
+```
+- What it does: Creates a project from a template (e.g., `fastapi-default`) and installs dependencies
+- Key options:
+  - `--project-name`, `--author`, `--author-email`, `--description`
+  - `--package-manager` [pip|uv|pdm|poetry]
+- Tip: List available templates with `fastkit list-templates`
+
+### Add a new route
+```console
+fastkit addroute <project_name> <route_name>
+```
+- What it does: Adds a new API route to the specified project
+
+### Run the development server
+```console
+fastkit runserver [OPTIONS]
+```
+- What it does: Starts the uvicorn development server
+- Key options:
+  - `--host`, `--port`, `--reload/--no-reload`, `--workers`
+
+### List templates
+```console
+fastkit list-templates
+```
+
+### Delete a project
+```console
+fastkit deleteproject <project_name>
+```
+
+## Documentation
+
+For comprehensive guides and detailed usage instructions, visit our documentation:
+
+- 📚 **[User Guide](https://bnbong.github.io/FastAPI-fastkit/user-guide/quick-start/)** - Detailed installation and usage guides
+- 🎯 **[Tutorial](https://bnbong.github.io/FastAPI-fastkit/tutorial/getting-started/)** - Step-by-step tutorials for beginners
+- 📖 **[CLI Reference](https://bnbong.github.io/FastAPI-fastkit/user-guide/cli-reference/)** - Complete command reference
+- 🔍 **[Template Quality Assurance](https://bnbong.github.io/FastAPI-fastkit/reference/template-quality-assurance/)** - Automated testing and quality standards
+
+## Contributing
+
+We welcome contributions from the community! FastAPI-fastkit is designed to help newcomers to Python and FastAPI, and your contributions can make a significant impact.
+
+<details>
+<summary><b>Contributing Guide</b></summary>
+
+### Quick Start for Contributors
+
+1. **Fork and clone the repository:**
+   ```bash
+   git clone https://github.com/bnbong/FastAPI-fastkit.git
+   cd FastAPI-fastkit
+   ```
+
+2. **Set up development environment:**
+   ```bash
+   make dev-setup  # Sets up everything you need
+   ```
+
+3. **Run development checks:**
+   ```bash
+   make dev-check  # Format, lint, and test
+   ```
+
+### What You Can Contribute
+
+- 🚀 **New FastAPI templates** - Add templates for different use cases
+- 🐛 **Bug fixes** - Help us improve stability and reliability
+- 📚 **Documentation** - Improve guides, examples, and translations
+- 🧪 **Tests** - Increase test coverage and add integration tests
+- 💡 **Features** - Suggest and implement new CLI features
+
+### Contribution Guidelines
+
+For detailed contribution guidelines, development setup, and project standards, please refer to:
+
+- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Comprehensive contribution guide
+- **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** - Project principles and community standards
+- **[SECURITY.md](SECURITY.md)** - Security guidelines and reporting
+
+</details>
+
+## Significance of FastAPI-fastkit
+
+FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
+
+This idea was initiated with the aim of helping FastAPI newcomers learn from the beginning, which aligns with the production significance of the FastAPI-cli package added with the [FastAPI 0.111.0 version update](https://github.com/fastapi/fastapi/releases/tag/0.111.0).
+
+As someone who has been using and loving FastAPI for a long time, I wanted to develop a project that could help fulfill [the wonderful motivation](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has expressed.
+
+FastAPI-fastkit bridges the gap between getting started and building production-ready applications by providing:
+
+- **Immediate productivity** for newcomers who might be overwhelmed by setup complexity
+- **Best practices** built into every template, helping users learn proper FastAPI patterns
+- **Scalable foundations** that grow with users as they advance from beginners to experts
+- **Community-driven templates** that reflect real-world FastAPI usage patterns
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/bnbong/FastAPI-fastkit/blob/main/LICENSE) file for details.

fastapi_fastkit-1.1.0/README.md

@@ -0,0 +1,160 @@
+<p align="center">
+    <img align="top" width="70%" src="https://bnbong.github.io/projects/img/fastkit_general_logo.png" alt="FastAPI-fastkit"/>
+</p>
+<p align="center">
+<em><b>FastAPI-fastkit</b>: Fast, easy-to-use starter kit for new users of Python and FastAPI</em>
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi-fastkit" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi-fastkit" alt="PyPI - Version">
+</a>
+<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
+    <img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
+</a>
+</p>
+
+---
+
+This project was created to speed up the configuration of the development environment needed to develop Python-based web apps for new users of Python and [FastAPI](https://github.com/fastapi/fastapi).
+
+This project was inspired by the `SpringBoot initializer` & Python Django's `django-admin` cli operation.
+
+## Key Features
+
+- **⚡ Immediate FastAPI project creation** : Super-fast FastAPI workspace & project creation via CLI, inspired by `django-admin` feature of [Python Django](https://github.com/django/django)
+- **🎨 Prettier CLI outputs** : Beautiful CLI experience powered by [rich library](https://github.com/Textualize/rich)
+- **📋 Standards-based FastAPI project templates** : All FastAPI-fastkit templates are based on Python standards and FastAPI's common use patterns
+- **🔍 Automated template quality assurance** : Weekly automated testing ensures all templates remain functional and up-to-date
+- **🚀 Multiple project templates** : Choose from various pre-configured templates for different use cases (async CRUD, Docker, PostgreSQL, etc.)
+- **📦 Multiple package manager support** : Choose your preferred Python package manager (pip, uv, pdm, poetry) for dependency management
+
+## Installation
+
+Install `FastAPI-fastkit` at your Python environment.
+
+```console
+$ pip install FastAPI-fastkit
+```
+
+
+## Usage
+
+- Global options
+  - `--help`: Show help
+  - `--version`: Show version
+  - `--debug/--no-debug`: Toggle debug mode
+
+### Create a new FastAPI project
+```console
+fastkit init [OPTIONS]
+```
+- What it does: Scaffolds an empty FastAPI project, creates a virtual environment, installs dependencies
+- Key options:
+  - `--project-name`, `--author`, `--author-email`, `--description`
+  - `--package-manager` [pip|uv|pdm|poetry]
+  - Stack selection: `minimal` | `standard` | `full` (interactive)
+
+### Create a project from a template
+```console
+fastkit startdemo [TEMPLATE] [OPTIONS]
+```
+- What it does: Creates a project from a template (e.g., `fastapi-default`) and installs dependencies
+- Key options:
+  - `--project-name`, `--author`, `--author-email`, `--description`
+  - `--package-manager` [pip|uv|pdm|poetry]
+- Tip: List available templates with `fastkit list-templates`
+
+### Add a new route
+```console
+fastkit addroute <project_name> <route_name>
+```
+- What it does: Adds a new API route to the specified project
+
+### Run the development server
+```console
+fastkit runserver [OPTIONS]
+```
+- What it does: Starts the uvicorn development server
+- Key options:
+  - `--host`, `--port`, `--reload/--no-reload`, `--workers`
+
+### List templates
+```console
+fastkit list-templates
+```
+
+### Delete a project
+```console
+fastkit deleteproject <project_name>
+```
+
+## Documentation
+
+For comprehensive guides and detailed usage instructions, visit our documentation:
+
+- 📚 **[User Guide](https://bnbong.github.io/FastAPI-fastkit/user-guide/quick-start/)** - Detailed installation and usage guides
+- 🎯 **[Tutorial](https://bnbong.github.io/FastAPI-fastkit/tutorial/getting-started/)** - Step-by-step tutorials for beginners
+- 📖 **[CLI Reference](https://bnbong.github.io/FastAPI-fastkit/user-guide/cli-reference/)** - Complete command reference
+- 🔍 **[Template Quality Assurance](https://bnbong.github.io/FastAPI-fastkit/reference/template-quality-assurance/)** - Automated testing and quality standards
+
+## Contributing
+
+We welcome contributions from the community! FastAPI-fastkit is designed to help newcomers to Python and FastAPI, and your contributions can make a significant impact.
+
+<details>
+<summary><b>Contributing Guide</b></summary>
+
+### Quick Start for Contributors
+
+1. **Fork and clone the repository:**
+   ```bash
+   git clone https://github.com/bnbong/FastAPI-fastkit.git
+   cd FastAPI-fastkit
+   ```
+
+2. **Set up development environment:**
+   ```bash
+   make dev-setup  # Sets up everything you need
+   ```
+
+3. **Run development checks:**
+   ```bash
+   make dev-check  # Format, lint, and test
+   ```
+
+### What You Can Contribute
+
+- 🚀 **New FastAPI templates** - Add templates for different use cases
+- 🐛 **Bug fixes** - Help us improve stability and reliability
+- 📚 **Documentation** - Improve guides, examples, and translations
+- 🧪 **Tests** - Increase test coverage and add integration tests
+- 💡 **Features** - Suggest and implement new CLI features
+
+### Contribution Guidelines
+
+For detailed contribution guidelines, development setup, and project standards, please refer to:
+
+- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Comprehensive contribution guide
+- **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** - Project principles and community standards
+- **[SECURITY.md](SECURITY.md)** - Security guidelines and reporting
+
+</details>
+
+## Significance of FastAPI-fastkit
+
+FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
+
+This idea was initiated with the aim of helping FastAPI newcomers learn from the beginning, which aligns with the production significance of the FastAPI-cli package added with the [FastAPI 0.111.0 version update](https://github.com/fastapi/fastapi/releases/tag/0.111.0).
+
+As someone who has been using and loving FastAPI for a long time, I wanted to develop a project that could help fulfill [the wonderful motivation](https://github.com/fastapi/fastapi/pull/11522#issuecomment-2264639417) that FastAPI developer [tiangolo](https://github.com/tiangolo) has expressed.
+
+FastAPI-fastkit bridges the gap between getting started and building production-ready applications by providing:
+
+- **Immediate productivity** for newcomers who might be overwhelmed by setup complexity
+- **Best practices** built into every template, helping users learn proper FastAPI patterns
+- **Scalable foundations** that grow with users as they advance from beginners to experts
+- **Community-driven templates** that reflect real-world FastAPI usage patterns
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/bnbong/FastAPI-fastkit/blob/main/LICENSE) file for details.

{fastapi_fastkit-1.0.1 → fastapi_fastkit-1.1.0}/pyproject.toml

@@ -11,7 +11,7 @@ dependencies = [
 ]
 requires-python = ">=3.12"
 readme = "README.md"
-version = "1.0.1"
+version = "1.1.0"
 
 [project.license]
 text = "MIT"
@@ -25,7 +25,7 @@ Changelog = "https://bnbong.github.io/FastAPI-fastkit/changelog/"
 [project.optional-dependencies]
 dev = [
     "pytest>=8.3.3",
-    "pytest-cov>=5.0.0",
+    "pytest-cov>=6.2.1",
     "black>=24.10.0",
     "pre-commit>=4.0.1",
     "mypy>=1.12.0",
@@ -50,9 +50,14 @@ path = "src/fastapi_fastkit/__init__.py"
 
 [tool.pytest.ini_options]
 testpaths = [
-    "test",
+    "tests",
 ]
 python_files = "test_*.py"
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "--disable-warnings",
+]
 
 [tool.isort]
 profile = "black"
@@ -71,9 +76,45 @@ module = "fastapi_fastkit.core"
 ignore_missing_imports = true
 check_untyped_defs = false
 
+[tool.coverage.run]
+source = [
+    "src/fastapi_fastkit",
+]
+omit = [
+    "*/tests/*",
+    "*/test_*",
+    "*/__pycache__/*",
+    "*/.*",
+    "*/venv/*",
+    "*/.venv/*",
+    "*/site-packages/*",
+    "*/fastapi_project_template/*",
+    "*/__main__.py",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]
+show_missing = true
+precision = 2
+fail_under = 70
+
+[tool.coverage.html]
+directory = "htmlcov"
+
 [dependency-groups]
 docs = [
     "mkdocs>=1.6.1",
-    "mkdocs-material>=9.6.14",
+    "mkdocs-material>=9.6.15",
     "mdx-include>=1.4.2",
 ]

fastapi_fastkit-1.1.0/src/fastapi_fastkit/__init__.py

@@ -0,0 +1 @@
+__version__ = 'v1.1.0'