Skip to content

Latest commit

 

History

History
92 lines (71 loc) · 3.58 KB

README.rst

File metadata and controls

92 lines (71 loc) · 3.58 KB

Welcome to drf-microservice documentation!

Build status Test coverage status pypi download python supported licence PyPi version Maintainability Documentation status PyPi wheel

About Drf-microservice

drf-microservice is a ready-to-use API skeleton:
And you:
  • add your unittest and endpoints,
And it will help you to:
  • generate the documentation with drf-yasg,
  • test it with Tox,
  • package it Docker,
  • deploy it (TODO with) Terraform or Ansible

It sounds simple and it is. Take a look at Drf-microservice it's now generated by Cookiescutter-drf-microservice.

Something disturb you in the code? Don't hesitate to open a an issue and contribute.

docker-compose

# create image(s) described in the docker-compose.yml:
docker-compose build
# Builds, (re)creates, starts, and attaches to containers for a service:
docker-compose up -d
# Stops, all the containers for a service:
docker-compose down

urls:

xx.xx.xx.xx:8000
xx.xx.xx.xx:8000/admin/
xx.xx.xx.xx:8000/swagger/openapi/

Releases notes

Bugs and evolution policies

When you will find a bug or propose an evolution create a ticket on:

Online documentation is here on readthedoc Online source code available on Github