Skip to content

Commit

Permalink
Updated README [no ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Achronus committed Sep 9, 2024
1 parent c8199c7 commit 20ed102
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@
![Last Commit](https://img.shields.io/github/last-commit/Achronus/zentra-api)


🚧 _In development_ 🚧

Zentra API, your CLI tool for building [FastAPI](https://fastapi.tiangolo.com/) projects faster.
Zentra API, your python package for building [FastAPI](https://fastapi.tiangolo.com/) projects faster.

Found on:

Expand All @@ -25,11 +23,11 @@ Say goodbye to the hassles of manual setup and configuration, and say hello to a

Zentra API isn't just about speed - it's about enhancing your entire development process. Its intuitive CLI simplifies project creation, allowing you to focus on what truly matters: crafting exceptional APIs.

With built-in templates, automated code generation, and seamless integration with popular tools and frameworks, Zentra API ensures your projects are not only fast to build but also maintain the highest standards of quality and performance. Elevate your FastAPI development game today!
With built-in templates, automated code generation, and seamless integration with popular tools and frameworks, Zentra API ensures your projects are not only fast to build but also maintain the highest standards of quality and performance.

# What's Great About It?

Our goal with Zentra API is to provide a suite of useful commands that improve the efficiency of building FastAPI apps. API development doesn't need to be a long winded process!
Our goal with Zentra API is to provide a suite of useful CLI commands and package features that improve the efficiency of building FastAPI apps. API development doesn't need to be a long winded process!

Here's some of the commands you can expect to see:

Expand All @@ -39,11 +37,10 @@ Here's some of the commands you can expect to see:
- [ ] `build` - creates a production ready version of your app with docker files
- [X] `new_key` - a quick way to generate a new authentication secret key

But, that's not all! We've also added a few extra features to make development a breeze:
We've also added a few extra features to make development a breeze:

- [ ] `Unit test templates` - when running one of the `add` commands, you'll automatically get some relevant [pytest](https://docs.pytest.org/en/stable/) unit tests added to the project
- [X] `Route outputs` - we've added a standardized template for API responses that follow best practices making your APIs a joy to work with
- [X] `Response models` - we provide utilities for quickly building response models from status codes that can be added to your routes in seconds
- [X] `Route outputs` - routes include a standardized template for API responses that follow best practices making your APIs a joy to work with
- [X] `Response models` - utilities for quickly building response models from status codes that can be added to your routes in seconds

And so much more...

Expand All @@ -67,13 +64,23 @@ With one command you'll have a working app in minutes with:

- Built-in user authentication with JWT token protection
- Preconfigured CORs middleware
- A [SQLite](https://www.sqlite.org/) database configured with [Alembic](https://alembic.sqlalchemy.org/en/latest/)
- A [SQLite](https://www.sqlite.org/) database configured with [Alembic](https://alembic.sqlalchemy.org/en/latest/) and [SQLAlchemy](https://www.sqlalchemy.org/)
- Built-in templated route responses following best practices
- A simple folder structure to make project navigation a breeze
- Prebuilt [Pytests](https://docs.pytest.org/en/stable/) so you can focus on your own code
- And, access to our package filled with other goodies

Read more about it in our [documentation](#) (🔜 _Coming soon!_ 🔜).
But that's not all! We've also got plans to add:

- Rate limiting with [SlowAPI](https://github.com/laurents/slowapi)
- API key configuration
- An admin interface for easily navigating your database
- Email based password recovery
- A [`build`](#) command to go from development to production in minutes
- And so much more...

Read more about it in our [documentation](https://zentra.achronus.dev/api).

## Zentra SDK
## Zentra Project

Zentra API is part of the `Zentra SDK` project. You can read more about it on [GitHub](https://github.com/Achronus/zentra).
Zentra API is part of the `Zentra` project. You can read more about it on [GitHub](https://github.com/Achronus/zentra).

0 comments on commit 20ed102

Please sign in to comment.