Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gr3yknigh1/users-api
Some users API written in FastAPI
https://github.com/gr3yknigh1/users-api
fastapi
Last synced: about 1 month ago
JSON representation
Some users API written in FastAPI
- Host: GitHub
- URL: https://github.com/gr3yknigh1/users-api
- Owner: gr3yknigh1
- License: other
- Created: 2023-09-28T09:48:43.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-09-29T12:27:15.000Z (about 1 year ago)
- Last Synced: 2023-09-30T01:43:54.211Z (about 1 year ago)
- Topics: fastapi
- Language: Python
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Users API
Some users API written in FastAPI
> Note: Project was tested only with Podman (instead of Docker)
## Stack
* FastAPI (uvicorn)
* PostgresSQL
* SQLAlchemy
## Usage
Checkout docs at `:/docs` for API details
## Configuration
Sample `.env` file (`./examples/dotenv`)
```env
# Sample Dotenv file
USERS_API_HOST=0.0.0.0
USERS_API_PORT=8000
USERS_API_LOG_LEVEL=DEBUG
POSTGRES_USER=users_api
POSTGRES_PASSWORD=pass
POSTGRES_ADDR=172.17.0.1
POSTGRES_PORT=5432
POSTGRES_DB=users
```
## Run
You need to setup environment variables in order to start server. You can use `examples/dotenv` for that.
> Note: You can copy `./examples/dotenv` to `./.env` for testing
```shell
docker compose up
```
## Build
* Docker image
```shell
docker build . --tag
```
* Python wheel
(See `dist/` directory)
```shell
make upgrade-buildsystem build
```
Or just
```shell
python3 -m pip install \
--upgrade pip
python3 -m pip install \
--upgrade setuptools \
--upgrade setuptools-git-versioning \
--upgrade wheel \
--upgrade build
python3 -m build
```
## Development setup
* Automatic
```shell
make setup
```
* Manual (make sure use to `virtualenv`)
```shell
python3 -m pip install -r dev-requirements.txt
pre-commit install
python3 -m pip install -e .
```