Powered by Cookiecutter, Django Naqsh is a bootstrapping tool for creating production-ready Django web services quickly.
This project is a fork of django-naqsh that is intended to be used as a REST API backend. Unnecessary modules for a REST API and codes are removed and custom User model is more developed.
- Documentation: https://django-naqsh.readthedocs.io/en/latest/
- See Troubleshooting for common errors and obstacles
- If you have problems with Django Naqsh, please open issues don't send emails to the maintainers.
- For Django 2.2
- Works with Python 3.7
- Renders Django projects with 100% starting test coverage
- 12-Factor based settings via django-environ
- Secure by default with SSL enabled.
- Optimized development and production settings
- Comes with custom user model with secure token authentication and email validation for RESTful API
- Send emails via Anymail (using Mailgun by default, but switchable)
- Media storage using Amazon S3, Google Cloud Storage or Minio
- Docker support using docker-compose for development and production (using Traefik with LetsEncrypt support)
- Procfile for deploying to Heroku
- Run tests with unittest or pytest
- Customizable PostgreSQL version
These features can be enabled during initial project setup.
- Serve static files from Amazon S3, Google Cloud Storage, Minio or Whitenoise
- Configuration for Celery and Flower (the latter in Docker setup only)
- Integration with MailHog for local email testing
- Integration with Sentry for error logging
- Only maintained 3rd party libraries are used.
- Uses PostgreSQL everywhere
- Environment variables for configuration (This won't work with Apache/mod_wsgi).
Let's pretend you want to create a Django project called "redditclone". Rather than using startproject
and then editing the results to include your name, email, and various configuration issues that always get forgotten until the worst possible moment, get cookiecutter to do all the work.
First, get Cookiecutter. Trust me, it's awesome:
$ pip install "cookiecutter>=1.4.0"
Now run it against this repo:
$ cookiecutter https://github.com/mazdakb/django-naqsh
You'll be prompted for some values. Provide them, then a Django project will be created for you.
Warning: After this point, change 'Mazdak Badakhshan', 'mazdakb', etc to your own information.
Answer the prompts with your own desired options. For example:
Cloning into 'django-naqsh'... remote: Counting objects: 550, done. remote: Compressing objects: 100% (310/310), done. remote: Total 550 (delta 283), reused 479 (delta 222) Receiving objects: 100% (550/550), 127.66 KiB | 58 KiB/s, done. Resolving deltas: 100% (283/283), done. project_name [Project Name]: Reddit Clone project_slug [reddit_clone]: reddit author_name [Mazdak Badakhshan]: Mazdak Badakhshan email [you@example.com]: geraneum@example.com description [Behold My Awesome Project!]: A reddit clone. domain_name [example.com]: myreddit.example.com version [0.1.0]: 0.0.1 timezone [UTC]: Europe/Berlin use_whitenoise [n]: n use_celery [n]: y use_mailhog [n]: n use_sentry [n]: y use_pycharm [n]: y windows [n]: n use_docker [n]: n use_heroku [n]: y use_compressor [n]: y Select postgresql_version: 1 - 11.5 2 - 10.10 3 - 9.6 4 - 9.5 5 - 9.4 Choose from 1, 2, 3, 4, 5 [1]: 1 Select cloud_provider: 1 - AWS 2 - GCP 3 - None Choose from 1, 2, 3 [1]: 1 Select open_source_license: 1 - MIT 2 - BSD 3 - GPLv3 4 - Apache Software License 2.0 5 - Not open source Choose from 1, 2, 3, 4, 5 [1]: 1 use_grappelli [y]: y use_cors_package [y]: y keep_local_envs_in_vcs [y]: y debug[n]: n
Enter the project and take a look around:
$ cd reddit/ $ ls
Create a git repo and push it there:
$ git init $ git add . $ git commit -m "first awesome commit" $ git remote add origin git@github.com:mazdakb/redditclone.git $ git push -u origin master
Now take a look at your repo. Don't forget to carefully look at the generated README. Awesome, right?
For local development, see the following:
- Have questions? Before you ask questions anywhere else, please post your question on Stack Overflow under django-naqsh or cookiecutter-django tags. We check there periodically for questions.
- If you think you found a bug or want to request a feature, please open an issue.
If you are using pyup.io to keep your dependencies updated and secure, use the code cookiecutter during checkout to get 15% off every month.
Scattered throughout the project are places marked with "your stuff". This is where third-party libraries are to be integrated with your project.
Need a stable release? You can find them at https://github.com/mazdakb/django-naqsh/releases
This is what I want. It might not be what you want. Don't worry, you have options:
If you have differences in your preferred setup, I encourage you to fork this to create your own version. Once you have your fork working, let me know and I'll add it to a 'Similar Cookiecutter Templates' list here. It's up to you whether or not to rename your fork.
If you do rename your fork, I encourage you to submit it to the following places:
- cookiecutter so it gets listed in the README as a template.
- The cookiecutter grid on Django Packages.
We accept pull requests if they're small, atomic, and make our own project development experience better.
You may find some materials refered in the cookiecutter-django's articles.
Everyone interacting in the Cookiecutter project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.