Historical Figures Repository

Historical Figures Repository is an application to manage a repository of historical figures.

It has been coded in Python3.8, using the FastAPI, Pydantic and Tortoise-ORM frameworks.

This application has been developed following the Test Driven Development (TDD) programming practice.

Demo

A demo application is deployed in Heroku.

Installation

Clone the repository. Use Docker and Docker Compose to build and run the project.

docker-compose up -d --build

Project Structure

└── project             # Python project
    └── app
    │   ├── api         # API services
    │   ├── models      # ORM models
    │   ├── schemas     # API Schemas
    │   ├── scripts     # Application scripts
    │   └── tests       # Integration/Unit tests
    └── db              # Database service

Interactive API docs

You could see here the automatic interactive API documentation (provided by Swagger UI)

Alternative API docs

Also, you could see here the alternative automatic documentation provided by ReDoc

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT