/python-rest-api

REST API for Python.

Primary LanguagePython

Python REST API

Purpose

REST API scaffold for Python.

Requirements

For development only:

Local:

API

Setup

Copy the .env.example to .env (NEVER COMMIT the .env file or sensitive data)

make env/file

Docker

make docker/build

Local

make install

How to run

Docker

make docker/run

Local

make

How to dev (with venv)

  • Create env
make env/create
  • Start env
source .venv/bin/activate

#or

make env
  • Install
make install
  • Run as developer mode (watch and reload)

We use Nodemon for this.

make dev
  • Run tests (watch and reload)
make tests/watch
  • Run tests once
make tests

Please check the Makefile for more options.

More info

Author