|
1 | | -# FastAPI Mason |
| 1 | +# FastAPI Ronin |
2 | 2 |
|
3 | 3 | <p align="center"> |
4 | 4 | <img align="center" src="docs/assets/logo.png" alt="logo" width="200"/> |
5 | | - <h1 align="center">FastAPI Mason</h1> |
| 5 | + <h1 align="center">FastAPI Ronin</h1> |
6 | 6 | </p> |
7 | 7 | <p align="center" markdown=1> |
8 | 8 | <i>Build REST APIs with Django REST Framework patterns in FastAPI</i> |
9 | 9 | </p> |
10 | 10 | <p align="center" markdown=1> |
11 | | -<a href="https://pypi.org/project/fastapi-mason/"> |
12 | | - <img src="https://img.shields.io/pypi/v/fastapi-mason?color=%2334D058&label=pypi%20package" alt="PyPi Version"/> |
| 11 | +<a href="https://pypi.org/project/fastapi-ronin/"> |
| 12 | + <img src="https://img.shields.io/pypi/v/fastapi-ronin?color=%2334D058&label=pypi%20package" alt="PyPi Version"/> |
13 | 13 | </a> |
14 | | -<a href="https://pypi.org/project/fastapi-mason/"> |
15 | | - <img src="https://img.shields.io/pypi/pyversions/fastapi-mason.svg?color=%2334D058" alt="Supported Python Versions"/> |
| 14 | +<a href="https://pypi.org/project/fastapi-ronin/"> |
| 15 | + <img src="https://img.shields.io/pypi/pyversions/fastapi-ronin.svg?color=%2334D058" alt="Supported Python Versions"/> |
16 | 16 | </a> |
17 | | -<a href="https://github.com/bubaley/fastapi-mason/blob/main/LICENSE"> |
| 17 | +<a href="https://github.com/bubaley/fastapi-ronin/blob/main/LICENSE"> |
18 | 18 | <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"/> |
19 | 19 | </a> |
20 | 20 | </p> |
|
23 | 23 |
|
24 | 24 | **Transform your FastAPI development with familiar Django REST Framework patterns.** |
25 | 25 |
|
26 | | -FastAPI Mason brings the beloved patterns and conventions from Django REST Framework to FastAPI, providing a structured and efficient way to build REST APIs. With familiar concepts like ViewSets, permissions, pagination, and serialization, you can rapidly develop robust API applications. |
| 26 | +FastAPI Ronin brings the beloved patterns and conventions from Django REST Framework to FastAPI, providing a structured and efficient way to build REST APIs. With familiar concepts like ViewSets, permissions, pagination, and serialization, you can rapidly develop robust API applications. |
27 | 27 |
|
28 | | -Just like skilled masons who craft solid foundations with precision and expertise, FastAPI Mason helps you build reliable, well-structured APIs with time-tested patterns and best practices. |
| 28 | +Just like skilled ronin who master their craft with precision and expertise, FastAPI Ronin helps you build reliable, well-structured APIs with time-tested patterns and best practices. |
29 | 29 |
|
30 | 30 | <hr> |
31 | | -<p><b>Documentation</b>: <a class="link" href="https://bubaley.github.io/fastapi-mason">bubaley.github.io/fastapi-mason</a></p> |
| 31 | +<p><b>Documentation</b>: <a class="link" href="https://bubaley.github.io/fastapi-ronin">bubaley.github.io/fastapi-ronin</a></p> |
32 | 32 | <hr> |
33 | 33 |
|
34 | 34 | <div style="margin: 2rem 0;"> |
35 | | - <a href="https://bubaley.github.io/fastapi-mason/quick-start/" class="get-started-btn"> |
| 35 | + <a href="https://bubaley.github.io/fastapi-ronin/quick-start/" class="get-started-btn"> |
36 | 36 | Get Started |
37 | 37 | </a> |
38 | 38 | </div> |
39 | 39 |
|
40 | 40 | ## 📦 Installation |
41 | 41 |
|
42 | | -Install FastAPI Mason using UV: |
| 42 | +Install FastAPI Ronin using UV: |
43 | 43 |
|
44 | 44 | ```bash |
45 | | -uv add fastapi-mason |
| 45 | +uv add fastapi-ronin |
46 | 46 | ``` |
47 | 47 |
|
48 | 48 | ## 🚀 Quick Example |
49 | 49 |
|
50 | | -Here's a complete example showing how to build a REST API with FastAPI Mason: |
| 50 | +Here's a complete example showing how to build a REST API with FastAPI Ronin: |
51 | 51 |
|
52 | 52 | ```python |
53 | | -# main.py - Complete FastAPI Mason application |
| 53 | +# main.py - Complete FastAPI Ronin application |
54 | 54 | from fastapi import APIRouter, FastAPI |
55 | 55 | from tortoise import fields |
56 | 56 | from tortoise.contrib.fastapi import register_tortoise |
57 | 57 | from tortoise.models import Model |
58 | 58 |
|
59 | | -from fastapi_mason.decorators import action, viewset |
60 | | -from fastapi_mason.pagination import PageNumberPagination |
61 | | -from fastapi_mason.schemas import SchemaMeta, build_schema, rebuild_schema |
62 | | -from fastapi_mason.viewsets import ModelViewSet |
63 | | -from fastapi_mason.wrappers import PaginatedResponseDataWrapper, ResponseDataWrapper |
| 59 | +from fastapi_ronin.decorators import action, viewset |
| 60 | +from fastapi_ronin.pagination import PageNumberPagination |
| 61 | +from fastapi_ronin.schemas import SchemaMeta, build_schema, rebuild_schema |
| 62 | +from fastapi_ronin.viewsets import ModelViewSet |
| 63 | +from fastapi_ronin.wrappers import PaginatedResponseDataWrapper, ResponseDataWrapper |
64 | 64 |
|
65 | 65 | # Database setup |
66 | 66 | def register_database(app: FastAPI): |
@@ -204,34 +204,34 @@ Request-scoped state management for sharing data across middleware and view comp |
204 | 204 |
|
205 | 205 | ## 🎯 Philosophy |
206 | 206 |
|
207 | | -FastAPI Mason is designed with these principles in mind: |
| 207 | +FastAPI Ronin is designed with these principles in mind: |
208 | 208 |
|
209 | | -- **Familiar**: If you know Django REST Framework, you already know FastAPI Mason |
| 209 | +- **Familiar**: If you know Django REST Framework, you already know FastAPI Ronin |
210 | 210 | - **Flexible**: Customize every aspect while maintaining sensible defaults |
211 | 211 | - **Fast**: Built on FastAPI's high-performance foundation |
212 | 212 | - **Modular**: Use only what you need, when you need it |
213 | 213 |
|
214 | 214 | ## 📚 Getting Started |
215 | 215 |
|
216 | | -Ready to build amazing APIs? Start with our [Quick Start guide](https://bubaley.github.io/fastapi-mason/quick-start/) to get up and running in minutes. |
| 216 | +Ready to build amazing APIs? Start with our [Quick Start guide](https://bubaley.github.io/fastapi-ronin/quick-start/) to get up and running in minutes. |
217 | 217 |
|
218 | 218 | Want to dive deeper? Explore our comprehensive guides: |
219 | 219 |
|
220 | | -- [ViewSets](https://bubaley.github.io/fastapi-mason/viewsets/) - Learn about the core ViewSet concepts |
221 | | -- [Schemas & Meta](https://bubaley.github.io/fastapi-mason/schemas/) - Master schema generation and meta classes |
222 | | -- [Permissions](https://bubaley.github.io/fastapi-mason/permissions/) - Secure your APIs with permission classes |
223 | | -- [Pagination](https://bubaley.github.io/fastapi-mason/pagination/) - Implement efficient data pagination |
224 | | -- [State Management](https://bubaley.github.io/fastapi-mason/state/) - Manage request-scoped state |
225 | | -- [Response Wrappers](https://bubaley.github.io/fastapi-mason/wrappers/) - Format consistent API responses |
| 220 | +- [ViewSets](https://bubaley.github.io/fastapi-ronin/viewsets/) - Learn about the core ViewSet concepts |
| 221 | +- [Schemas & Meta](https://bubaley.github.io/fastapi-ronin/schemas/) - Master schema generation and meta classes |
| 222 | +- [Permissions](https://bubaley.github.io/fastapi-ronin/permissions/) - Secure your APIs with permission classes |
| 223 | +- [Pagination](https://bubaley.github.io/fastapi-ronin/pagination/) - Implement efficient data pagination |
| 224 | +- [State Management](https://bubaley.github.io/fastapi-ronin/state/) - Manage request-scoped state |
| 225 | +- [Response Wrappers](https://bubaley.github.io/fastapi-ronin/wrappers/) - Format consistent API responses |
226 | 226 |
|
227 | 227 | ## 🤝 Community |
228 | 228 |
|
229 | | -FastAPI Mason is open source and welcomes contributions! Whether you're reporting bugs, suggesting features, or submitting pull requests, your involvement helps make the library better for everyone. |
| 229 | +FastAPI Ronin is open source and welcomes contributions! Whether you're reporting bugs, suggesting features, or submitting pull requests, your involvement helps make the library better for everyone. |
230 | 230 |
|
231 | | -- **GitHub**: [github.com/bubaley/fastapi-mason](https://github.com/bubaley/fastapi-mason) |
| 231 | +- **GitHub**: [github.com/bubaley/fastapi-ronin](https://github.com/bubaley/fastapi-ronin) |
232 | 232 | - **Issues**: Report bugs and request features |
233 | 233 | - **Discussions**: Get help and share ideas |
234 | 234 |
|
235 | 235 | ## 📄 License |
236 | 236 |
|
237 | | -FastAPI Mason is released under the [MIT License](https://github.com/bubaley/fastapi-mason/blob/main/LICENSE). |
| 237 | +FastAPI Ronin is released under the [MIT License](https://github.com/bubaley/fastapi-ronin/blob/main/LICENSE). |
0 commit comments