Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yezz123/dogeapi
API with high performance to create a simple blog and Auth using OAuth2 ⛏
https://github.com/yezz123/dogeapi
api asyncio backend fastapi python python3 rest-api sqlalchemy sqlite swagger-ui uvicorn
Last synced: about 8 hours ago
JSON representation
API with high performance to create a simple blog and Auth using OAuth2 ⛏
- Host: GitHub
- URL: https://github.com/yezz123/dogeapi
- Owner: yezz123
- License: mit
- Created: 2021-05-12T07:43:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-14T17:15:52.000Z (6 months ago)
- Last Synced: 2024-10-26T23:55:57.281Z (19 days ago)
- Topics: api, asyncio, backend, fastapi, python, python3, rest-api, sqlalchemy, sqlite, swagger-ui, uvicorn
- Language: Python
- Homepage: https://blog.yezz.me/blog/Build-and-Secure-an-API-in-Python-with-FastAPI
- Size: 200 KB
- Stars: 146
- Watchers: 4
- Forks: 37
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# DogeAPI
API with high performance built with FastAPI & SQLAlchemy, help to improve connection with your Backend Side to create a simple blog and Cruds with OAuth2PasswordBearer ⛏
## Getting Started
### Prerequisites
- Python 3.8.6 or higher
- FastAPI
- Docker
### Project Setup
```sh
# clone the repo
$ git clone https://github.com/yezz123/DogeAPI
# move to the project folder
$ cd DogeAPI
```
### Creating Virtual Environment
- Create a virtual environment using virtualenv.
```shell
# creating virtual environment
$ virtualenv venv
# activate virtual environment
$ source venv/bin/activate
# install all dependencies
$ pip install -r requirements.txt
```
### Running the Application
- To run the [Main](main.py) we need to use [uvicorn](https://www.uvicorn.org/) a lightning-fast ASGI server implementation, using uvloop and httptools.
```sh
# Running the application using uvicorn
$ uvicorn main:app --reload
```
### Environment Variables
- `SECRET_KEY`: A secret key for signing Json Web Token.
- `DATABASE_URL`: The database url to connect to the database.
- `ACCESS_TOKEN_EXPIRE_MINUTES`: The access token expire minutes.
> change all the environment variables in the `.env.sample` and don't forget to rename it to `.env`.
### Configured Environment
#### Models
- Here for the [Models.py](models/models.py), i create 2 tables based on the requirements for this project `blogs` and `users`
## Running the Docker Container
- We have the Dockerfile created in above section. Now, we will use the Dockerfile to create the image of the FastAPI app and then start the FastAPI app container.
- Using a preconfigured `Makefile` tor run the Docker Compose:
```sh
# Pull the latest image
$ make pull
# Build the image
$ make build
# Run the container
$ make start
```
## Preconfigured Packages
Includes preconfigured packages to kick start DogeAPI by just setting appropriate configuration.
| Package | Usage |
| ------------------------------------------------------------ | ---------------------------------------------------------------- |
| [uvicorn](https://www.uvicorn.org/) | a lightning-fast ASGI server implementation, using uvloop and httptools. |
| [Python-Jose](https://github.com/mpdavis/python-jose) | a JavaScript Object Signing and Encryption implementation in Python. |
| [SQLAlchemy](https://www.sqlalchemy.org/) | is the Python SQL toolkit and Object Relational Mapper that gives application developers the full power and flexibility of SQL. |
| [starlette](https://www.starlette.io/) | a lightweight ASGI framework/toolkit, which is ideal for building high performance asyncio services. |
| [passlib](https://passlib.readthedocs.io/en/stable/) | a password hashing library for Python 2 & 3, which provides cross-platform implementations of over 30 password hashing algorithms |
| [bcrypt](https://github.com/pyca/bcrypt/) | Good password hashing for your software and your servers. |
| [python-multipart](https://github.com/andrew-d/python-multipart) | streaming multipart parser for Python. |
`yapf` packages for `linting and formatting`
## Contributing
- Join the DOGEAPI Creator and Contribute to the Project if you have any enhancement or add-ons to create a good and Secure Project, Help any User to Use it in a good and simple way.
- Check all information here at [docs's Folder](docs) to understand to how to contribute or to Read the Code of Conduct.
## License
This project is licensed under the terms of the MIT license.