Skip to content

Commit 176e4bd

Browse files
committed
feat!: Rename to fastapi-ronin
1 parent 2fc98ce commit 176e4bd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+272
-272
lines changed

MANIFEST.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ include LICENSE
22
include README.md
33
include pyproject.toml
44

5-
recursive-include fastapi_mason *.py
6-
recursive-include fastapi_mason *.json
7-
recursive-include fastapi_mason *.txt
5+
recursive-include fastapi_ronin *.py
6+
recursive-include fastapi_ronin *.json
7+
recursive-include fastapi_ronin *.txt
88

99
global-exclude *.py[cod]
1010
global-exclude __pycache__

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# FastAPI Mason
1+
# FastAPI Ronin
22

33
<p align="center">
44
<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>
66
</p>
77
<p align="center" markdown=1>
88
<i>Build REST APIs with Django REST Framework patterns in FastAPI</i>
99
</p>
1010
<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"/>
1313
</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"/>
1616
</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">
1818
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"/>
1919
</a>
2020
</p>
@@ -23,44 +23,44 @@
2323

2424
**Transform your FastAPI development with familiar Django REST Framework patterns.**
2525

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.
2727

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.
2929

3030
<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>
3232
<hr>
3333

3434
<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">
3636
Get Started
3737
</a>
3838
</div>
3939

4040
## 📦 Installation
4141

42-
Install FastAPI Mason using UV:
42+
Install FastAPI Ronin using UV:
4343

4444
```bash
45-
uv add fastapi-mason
45+
uv add fastapi-ronin
4646
```
4747

4848
## 🚀 Quick Example
4949

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:
5151

5252
```python
53-
# main.py - Complete FastAPI Mason application
53+
# main.py - Complete FastAPI Ronin application
5454
from fastapi import APIRouter, FastAPI
5555
from tortoise import fields
5656
from tortoise.contrib.fastapi import register_tortoise
5757
from tortoise.models import Model
5858

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
6464

6565
# Database setup
6666
def register_database(app: FastAPI):
@@ -204,34 +204,34 @@ Request-scoped state management for sharing data across middleware and view comp
204204

205205
## 🎯 Philosophy
206206

207-
FastAPI Mason is designed with these principles in mind:
207+
FastAPI Ronin is designed with these principles in mind:
208208

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
210210
- **Flexible**: Customize every aspect while maintaining sensible defaults
211211
- **Fast**: Built on FastAPI's high-performance foundation
212212
- **Modular**: Use only what you need, when you need it
213213

214214
## 📚 Getting Started
215215

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.
217217

218218
Want to dive deeper? Explore our comprehensive guides:
219219

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
226226

227227
## 🤝 Community
228228

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.
230230

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)
232232
- **Issues**: Report bugs and request features
233233
- **Discussions**: Get help and share ideas
234234

235235
## 📄 License
236236

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).

app/core/viewsets.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
from fastapi_mason.pagination import PageNumberPagination
2-
from fastapi_mason.types import ModelType
3-
from fastapi_mason.viewsets import ModelViewSet
4-
from fastapi_mason.wrappers import PaginatedResponseDataWrapper, ResponseDataWrapper
1+
from fastapi_ronin.pagination import PageNumberPagination
2+
from fastapi_ronin.types import ModelType
3+
from fastapi_ronin.viewsets import ModelViewSet
4+
from fastapi_ronin.wrappers import PaginatedResponseDataWrapper, ResponseDataWrapper
55

66

77
class BaseModelViewSet(ModelViewSet[ModelType]):

app/domains/company/filters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from app.domains.company.models import Company, CompanyStatus
2-
from fastapi_mason import filters
2+
from fastapi_ronin import filters
33

44

55
class CompanyFilterSet(filters.FilterSet):

app/domains/company/meta.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from app.core.models import BASE_FIELDS
2-
from fastapi_mason.schemas import SchemaMeta
2+
from fastapi_ronin.schemas import SchemaMeta
33

44

55
class CompanyMeta(SchemaMeta):

app/domains/company/schemas.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from app.domains.company.meta import CompanyMeta
22
from app.domains.company.models import Company
3-
from fastapi_mason.schemas import build_schema, rebuild_schema
3+
from fastapi_ronin.schemas import build_schema, rebuild_schema
44

55
CompanySchema = build_schema(Company, meta=CompanyMeta)
66
CompanyCreateSchema = rebuild_schema(CompanySchema, exclude_readonly=True)

app/domains/company/views.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
from app.domains.company.filters import CompanyFilterSet
55
from app.domains.company.models import Company
66
from app.domains.company.schemas import CompanyCreateSchema, CompanySchema
7-
from fastapi_mason.decorators import action, viewset
8-
from fastapi_mason.permissions import IsAuthenticated
7+
from fastapi_ronin.decorators import action, viewset
8+
from fastapi_ronin.permissions import IsAuthenticated
99

1010
router = APIRouter(prefix='/companies', tags=['companies'])
1111

app/domains/project/meta.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from app.core.models import BASE_FIELDS
22
from app.domains.company.meta import CompanyMeta
3-
from fastapi_mason.schemas import SchemaMeta, build_schema_meta
3+
from fastapi_ronin.schemas import SchemaMeta, build_schema_meta
44

55

66
class ProjectMeta(SchemaMeta):

app/domains/project/schemas.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
from app.domains.project.meta import get_project_with_tasks_meta, get_task_with_project_meta
66
from app.domains.project.models import Project, Task
7-
from fastapi_mason.schemas import ConfigSchemaMeta, build_schema, rebuild_schema
7+
from fastapi_ronin.schemas import ConfigSchemaMeta, build_schema, rebuild_schema
88

99
ProjectReadSchema = build_schema(
1010
Project,

app/domains/project/views.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
TaskCreateSchema,
99
TaskReadSchema,
1010
)
11-
from fastapi_mason import decorators
12-
from fastapi_mason.pagination import DisabledPagination
13-
from fastapi_mason.viewsets import ModelViewSet
11+
from fastapi_ronin import decorators
12+
from fastapi_ronin.pagination import DisabledPagination
13+
from fastapi_ronin.viewsets import ModelViewSet
1414

1515
router = APIRouter(prefix='/projects', tags=['projects'])
1616

0 commit comments

Comments
 (0)