agconti / cookiecutter-django-rest

Build best practiced apis fast with Python3

cookiecutter-django-rest

a factory for building bleeding edge, best practiced, scalable, rest apis

You need to make a scalable api on a deadline. You deeply care about the quality of your work. cookiecutter-django-rest takes care of the details so you can focus on making your api awesome. Scaffolding a project takes seconds and it gives you authentication, user accounts, and the docs and tests to support them. Just add your own resources to the api and start shipping. ✨ 💅

Highlights

• Modern Python development with Python 3.8+
• Bleeding edge Django 3.0+
• Fully dockerized, local development via docker-compose.
• PostgreSQL 11.6+
• Start off with full test coverage and continuous integration.
• Complete Django Rest Framework integration
• Always current dependencies and security updates enforced by pyup.io.
• A slim but robust foundation -- just enough to maximize your productivity, nothing more.

Quick Start

Install cookiecutter:

brew install cookiecutter

Scaffold your project:

cookiecutter gh:agconti/cookiecutter-django-rest

Example of the result: https://github.com/agconti/piedpiper-web

Try creating a user!

curl -d '{"username":"'"$RANDOM"'", "password":"test", "email":"[email protected]", "first_name":"test", "last_name":"user"}' \
     -H "Content-Type: application/json" \
     -X POST https://piedpiper-prod.herokuapp.com/api/v1/users/

cookiecutter-django-rest's Issues

Handle "/" routing

Add api docs for auth

Add django-storages-redux config to production.

Tests should have `--nologcapture` added to the NOSE_ARGS

This is just really a proposal to add --nologcapture to the standard python manage.py test command. This because the logs are mainly queries from Factory boy and requests, which are not really insightful.

Add api docs for user app

Add `contributing.md`

Update to DRF 3.2.3

RelatedObjectDoesNotExist: User has no auth_token.

add fab dev and qa tasks back in

Update pg backups with schedule time

heroku pg:backups schedule DATABASE --at '04:00 UTC' --remote dev

Add *.pyc to gitignore

Upgrade Django-pnm to 1.6

Migrate the database after deploys

run:
  -  ./piedpiper/mange.py migrate

Exclude migrations from flake8

Update travis badge to private repo

Add github username to heroku repo deploy

Update `.travis` postgres config

Currently it uses {{ cookiecutter.repo_name }} instead of the property github_repository_name. Introduced in #70

Update django-pnm to 0.1.5

Release 0.2.0

• Update heroku postgresql addon config #98
• Fix fabfile spacing #103
• Do super() in test case of users #106
• Remove auth_token from UserSerializer #104
• Set up automated testing via travis #107

Remove email notifications from travis

Add a fab task to make and apply migrations

Add `.coveragerc`

Configure Django template debug settings

Add gif of scaffolding to ReadMe

Exclude mkdocs site dir via gitignore

Update cookie cutter params to specify username / **organization name **

Release 0.1.0

• Update users app with the appropriate test cases #1
• Add api docs for user app #2
• add tests for auth tokens #43
• Add api docs for auth #3
• Add django-storages-redux config to production. #6
• Handle "/" routing #7
• add redis to app readme prerequisites. #9
• Upgrade mkdocs to 0.14.0 #10
• Add git init to project ReadMe #17
• Update pg backups with schedule time #18
• Migrate the database after deploys #19
• add fab dev and qa tasks back in #20
• Update docs index to include readme #27
• Update flake8 fab task to target project dir #30
• Exclude migrations from flake8 #31
• Configure nosetests arguments #32
• Update flake8 to allow for easy debugging #37
• Add faker for mocking #41
• Remove email notifications from travis #48
• Update cookie cutter params to specify username / organization name #47
• Add github username to heroku repo deploy #46
• Update app routing to use a single DefaultRouter #45
• Exclude mkdocs site dir via gitignore #52
• Update django-pnm to 0.1.5 #54
• Update Authentication docs to include obtain auth_token endpoint #56
• Add caching via django-redis to features list #58
• Update ReadMe with more detailed background on project #60
• Upgrade to Django 1.8 after django-configurations has been upgraded. #8
• Add gif of scaffolding to ReadMe #66
• Fix broken heroku run command #71
• Database values are not set in Travis file #69
• Running ./manage.py test will result in "Coverage.py warning: Module walc was never imported." #67
• Tests should have --nologcapture added to the NOSE_ARGS #77
• Add contributing.md #74
• RelatedObjectDoesNotExist: User has no auth_token. #75
• Configure Django template debug settings #82
• Update to DRF 3.2.3 #81
• Update to Django 1.8.4 #80
• Upgrade Django-pnm to 1.6 #86
• Update RedirectView.permanent to true for api-root route #90
• Upgrade dependencies #89
• Update .travis postgres config #88
• Add .coveragerc #73

Update users app with the appropriate test cases

add tests for auth tokens

Upgrade auth to use jwt

Add caching via django-redis to features list

Update ReadMe with more detailed background on project

Update Authentication docs to include obtain `auth_token` endpoint

Update flake8 fab task to target project dir

Use standard django-configurations once it releases `0.9`

Temporally fixed in with #8 in #64

Running ./manage.py test will result in "Coverage.py warning: Module walc was never imported."

This is a new bug that is caused by the coverage package. I'm not sure how we could resolve this issue or if we ever want to do that. It's a personal preference to be in the app folder instead of the repo folder.

Any thoughts @agconti?

Upgrade user model `pk`s to `uuids`

Update app routing to use a single DefaultRouter

Database values are not set in Travis file

Add `git init` to project ReadMe

Configure nosetests arguments

Update flake8 to allow for easy debugging

Evaluate django-q to replace django-rq

https://github.com/Koed00/django-q

Upgrade to Django 1.8 after django-configurations has been upgraded.

jazzband/django-configurations#105 (comment)

Upgrade mkdocs to 0.14.0

Update to Django 1.8.4

Add faker for mocking

Fix broken heroku run command

Update docs index to include readme

add redis to app readme prerequisites.