s3-files-api

A project to demonstrate building high-quality APIs and SDKs with FastAPI.

Features:

• OpenAPI schema generation and diffing.
• Automatic Python SDK generation

Quick start

pip install s3-files-api

from files_api import ...

Developing/Contributing

System requirements

You will need the following installed on your machine to develop on this codebase

• make AKA cmake, e.g. sudo apt-get update -y; sudo apt-get install cmake -y
• Python 3.7+, ideally using pyenv to easily change between Python versions
• git

# clone the repo
git clone https://github.com/nrsmac/s3-files-api.git

# install the dev dependencies
make install

# run the tests
make test
# generate the sdk

make generate-client-library