https://github.com/agconti/cookiecutter-django-rest

Build best practiced apis fast with Python3
https://github.com/agconti/cookiecutter-django-rest

api boilerplate django docker python python3 rest rest-api

Last synced: 3 days ago
JSON representation

Build best practiced apis fast with Python3

• Host: GitHub
• URL: https://github.com/agconti/cookiecutter-django-rest
• Owner: agconti
• License: mit
• Created: 2015-06-04T16:46:49.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T12:04:12.000Z (about 2 months ago)
• Last Synced: 2024-10-29T14:34:38.688Z (about 2 months ago)
• Topics: api, boilerplate, django, docker, python, python3, rest, rest-api
• Language: Python
• Homepage: http://agconti.github.io/cookiecutter-django-rest/
• Size: 4.81 MB
• Stars: 1,545
• Watchers: 22
• Forks: 188
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

  
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](https://github.com/agconti/cookiecutter-django-rest/blob/master/%7B%7Bcookiecutter.github_repository_name%7D%7D/docs/api/authentication.md), [user accounts](https://github.com/agconti/cookiecutter-django-rest/blob/master/%7B%7Bcookiecutter.github_repository_name%7D%7D/%7B%7Bcookiecutter.app_name%7D%7D/users/views.py), and the [docs](https://github.com/agconti/cookiecutter-django-rest/blob/master/%7B%7Bcookiecutter.github_repository_name%7D%7D/docs/api/users.md) and [tests](https://github.com/agconti/cookiecutter-django-rest/blob/master/%7B%7Bcookiecutter.github_repository_name%7D%7D/%7B%7Bcookiecutter.app_name%7D%7D/users/test/test_views.py) to support them. Just add your own resources to the api and start shipping. ✨ 💅

## Highlights

- Modern Python development with Python 3.12+

- Bleeding edge Django 5.0+

- Fully dockerized, local development via docker-compose.

- PostgreSQL 16.4+

- Start off with full test coverage and [continuous integration](https://github.com/agconti/cookiecutter-django-rest/blob/master/%7B%7Bcookiecutter.github_repository_name%7D%7D/.travis.yml).

- Complete [Django Rest Framework](http://www.django-rest-framework.org/) integration

- Always current dependencies and security updates enforced by [pyup.io](https://pyup.io/).

- A slim but robust foundation -- just enough to maximize your productivity, nothing more.

## Quick Start

Install [cookiecutter](https://github.com/audreyr/cookiecutter):

```bash

brew install cookiecutter

```

Scaffold your project:

```

cookiecutter gh:agconti/cookiecutter-django-rest

```

![Scaffolding](media/scaffolding.gif)

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

Try creating a user!

```bash

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/

```