mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2025-08-15 09:24:52 +03:00
feat: template code base change
This commit is contained in:
parent
aa6cc603e2
commit
401f5c43f0
21
.github/CONTRIBUTORS-template.md
vendored
21
.github/CONTRIBUTORS-template.md
vendored
|
@ -25,27 +25,6 @@ accept and merge pull requests.
|
||||||
*Audrey is also the creator of Cookiecutter. Audrey and Daniel are on
|
*Audrey is also the creator of Cookiecutter. Audrey and Daniel are on
|
||||||
the Cookiecutter core team.*
|
the Cookiecutter core team.*
|
||||||
|
|
||||||
## Other Contributors
|
|
||||||
|
|
||||||
Listed in alphabetical order.
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th>Name</th>
|
|
||||||
<th>Github</th>
|
|
||||||
<th>Twitter</th>
|
|
||||||
</tr>
|
|
||||||
{%- for contributor in other_contributors %}
|
|
||||||
<tr>
|
|
||||||
<td>{{ contributor.name }}</td>
|
|
||||||
<td>
|
|
||||||
<a href="https://github.com/{{ contributor.github_login }}">{{ contributor.github_login }}</a>
|
|
||||||
</td>
|
|
||||||
<td>{{ contributor.twitter_username }}</td>
|
|
||||||
</tr>
|
|
||||||
{%- endfor %}
|
|
||||||
</table>
|
|
||||||
|
|
||||||
### Special Thanks
|
### Special Thanks
|
||||||
|
|
||||||
The following haven't provided code directly, but have provided
|
The following haven't provided code directly, but have provided
|
||||||
|
|
4
.github/FUNDING.yml
vendored
4
.github/FUNDING.yml
vendored
|
@ -1,7 +1,6 @@
|
||||||
# These are supported funding model platforms
|
# These are supported funding model platforms
|
||||||
|
|
||||||
github: [pydanny, browniebroke]
|
github: [jbanimineni]
|
||||||
patreon: feldroy
|
|
||||||
open_collective: # Replace with a single Open Collective username
|
open_collective: # Replace with a single Open Collective username
|
||||||
ko_fi: # Replace with a single Ko-fi username
|
ko_fi: # Replace with a single Ko-fi username
|
||||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||||
|
@ -9,4 +8,3 @@ community_bridge: # Replace with a single Community Bridge project-name e.g., cl
|
||||||
liberapay: # Replace with a single Liberapay username
|
liberapay: # Replace with a single Liberapay username
|
||||||
issuehunt: # Replace with a single IssueHunt username
|
issuehunt: # Replace with a single IssueHunt username
|
||||||
otechie: # Replace with a single Otechie username
|
otechie: # Replace with a single Otechie username
|
||||||
custom: ["https://www.patreon.com/browniebroke"]
|
|
||||||
|
|
2
.github/ISSUE_TEMPLATE/bug.md
vendored
2
.github/ISSUE_TEMPLATE/bug.md
vendored
|
@ -51,7 +51,7 @@ labels: bug
|
||||||
Logs:
|
Logs:
|
||||||
<details>
|
<details>
|
||||||
<pre>
|
<pre>
|
||||||
$ cookiecutter https://github.com/cookiecutter/cookiecutter-django
|
$ cookiecutter https://github.com/packershift/cookiecutter-django-quickstart
|
||||||
project_name [Project Name]: ...
|
project_name [Project Name]: ...
|
||||||
</pre>
|
</pre>
|
||||||
</details>
|
</details>
|
||||||
|
|
8
.github/ISSUE_TEMPLATE/paid-support.md
vendored
8
.github/ISSUE_TEMPLATE/paid-support.md
vendored
|
@ -3,10 +3,6 @@ name: Paid Support Request
|
||||||
about: Ask Core Team members to help you out
|
about: Ask Core Team members to help you out
|
||||||
---
|
---
|
||||||
|
|
||||||
Provided your question goes beyond [regular support](https://github.com/cookiecutter/cookiecutter-django/issues/new?template=question.md), and/or the task at hand is of timely/high priority nature use the below information to reach out for contributors directly.
|
Provided your question goes beyond [regular support](https://github.com/packershift/cookiecutter-django-quickstart/issues/new?template=question.md), and/or the task at hand is of timely/high priority nature use the below information to reach out for contributors directly.
|
||||||
|
|
||||||
* Daniel Roy Greenfeld, Project Lead ([GitHub](https://github.com/pydanny), [Patreon](https://www.patreon.com/danielroygreenfeld)): expertise in Django and AWS ELB.
|
* Jeh, Project Lead ([GitHub](https://github.com/jbanimineni), expertise in Django and DevOps, DevSecOps.
|
||||||
|
|
||||||
* Nikita Shupeyko, Core Developer ([GitHub](https://github.com/webyneter)): expertise in Python/Django, hands-on DevOps and frontend experience.
|
|
||||||
|
|
||||||
* Bruno Alla, Core Developer ([GitHub](https://github.com/sponsors/browniebroke)).
|
|
||||||
|
|
5
.github/ISSUE_TEMPLATE/question.md
vendored
5
.github/ISSUE_TEMPLATE/question.md
vendored
|
@ -6,6 +6,5 @@ labels: question
|
||||||
|
|
||||||
First, make sure to examine [the docs](https://cookiecutter-django.readthedocs.io/en/latest/). If that doesn't help, we recommend one of these 3 main channels:
|
First, make sure to examine [the docs](https://cookiecutter-django.readthedocs.io/en/latest/). If that doesn't help, we recommend one of these 3 main channels:
|
||||||
|
|
||||||
- If your issue is related to Django + something else but was generated with cookiecutter-django, the best is to post a question on [StackOverflow](https://stackoverflow.com/questions/tagged/cookiecutter-django) tagged with `cookiecutter-django`, you would get more visibility from other communities as well.
|
- Join us on [Discord](https://discord.gg/SQTCyMUrms) and ask around.
|
||||||
- Join us on [Discord](https://discord.gg/uFXweDQc5a) and ask around.
|
- Start [a discussion](https://github.com/packershift/cookiecutter-django-quickstart/discussions) on our project's GitHub.
|
||||||
- Start [a discussion](https://github.com/cookiecutter/cookiecutter-django/discussions) on our project's GitHub.
|
|
||||||
|
|
1298
.github/contributors.json
vendored
1298
.github/contributors.json
vendored
File diff suppressed because it is too large
Load Diff
2
.github/workflows/django-issue-checker.yml
vendored
2
.github/workflows/django-issue-checker.yml
vendored
|
@ -12,7 +12,7 @@ on:
|
||||||
jobs:
|
jobs:
|
||||||
issue-checker:
|
issue-checker:
|
||||||
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
||||||
if: github.repository_owner == 'cookiecutter'
|
if: github.repository_owner == 'packershift'
|
||||||
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
2
.github/workflows/issue-manager.yml
vendored
2
.github/workflows/issue-manager.yml
vendored
|
@ -19,7 +19,7 @@ on:
|
||||||
jobs:
|
jobs:
|
||||||
issue-manager:
|
issue-manager:
|
||||||
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
||||||
if: github.repository_owner == 'cookiecutter'
|
if: github.repository_owner == 'packershift'
|
||||||
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
2
.github/workflows/pre-commit-autoupdate.yml
vendored
2
.github/workflows/pre-commit-autoupdate.yml
vendored
|
@ -14,7 +14,7 @@ permissions:
|
||||||
jobs:
|
jobs:
|
||||||
auto-update:
|
auto-update:
|
||||||
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
||||||
if: github.repository_owner == 'cookiecutter'
|
if: github.repository_owner == 'packershift'
|
||||||
permissions:
|
permissions:
|
||||||
contents: write # for peter-evans/create-pull-request to create branch
|
contents: write # for peter-evans/create-pull-request to create branch
|
||||||
pull-requests: write # for peter-evans/create-pull-request to create a PR
|
pull-requests: write # for peter-evans/create-pull-request to create a PR
|
||||||
|
|
2
.github/workflows/update-changelog.yml
vendored
2
.github/workflows/update-changelog.yml
vendored
|
@ -10,7 +10,7 @@ on:
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
||||||
if: github.repository_owner == 'cookiecutter'
|
if: github.repository_owner == 'packershift'
|
||||||
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
2
.github/workflows/update-contributors.yml
vendored
2
.github/workflows/update-contributors.yml
vendored
|
@ -11,7 +11,7 @@ permissions:
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
# Disables this workflow from running in a repository that is not part of the indicated organization/user
|
||||||
if: github.repository_owner == 'cookiecutter'
|
if: github.repository_owner == 'packershift'
|
||||||
permissions:
|
permissions:
|
||||||
contents: write # for stefanzweifel/git-auto-commit-action to push code in repo
|
contents: write # for stefanzweifel/git-auto-commit-action to push code in repo
|
||||||
|
|
||||||
|
|
|
@ -8,11 +8,19 @@ update: all
|
||||||
# allowed: True, False
|
# allowed: True, False
|
||||||
pin: True
|
pin: True
|
||||||
|
|
||||||
|
# set the default branch
|
||||||
|
# default: empty, the default branch on GitHub
|
||||||
|
branch: main
|
||||||
|
|
||||||
# add a label to pull requests, default is not set
|
# add a label to pull requests, default is not set
|
||||||
# requires private repo permissions, even on public repos
|
# requires private repo permissions, even on public repos
|
||||||
# default: empty
|
# default: empty
|
||||||
label_prs: update
|
label_prs: update
|
||||||
|
|
||||||
|
# set a global prefix for PRs
|
||||||
|
# default: empty
|
||||||
|
pr_prefix: "Bug #12345"
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "requirements.txt"
|
- "requirements.txt"
|
||||||
- "docs/requirements.txt"
|
- "docs/requirements.txt"
|
||||||
|
|
2975
CHANGELOG.md
2975
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
|
@ -1,3 +1,3 @@
|
||||||
## Code of Conduct
|
## Code of Conduct
|
||||||
|
|
||||||
Everyone who interacts in the Cookiecutter project's codebase, issue trackers, chat rooms, and mailing lists is expected to follow the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).
|
Everyone who interacts in the Cookiecutter project's codebase, issue trackers, chat rooms, and mailing lists is expected to follow the [PackerShift Code of Conduct](https://github.com/packershift/.github/blob/main/CODE_OF_CONDUCT.md/).
|
||||||
|
|
|
@ -1,11 +1,26 @@
|
||||||
# How to Contribute
|
# Contributing to Cookicutter-Django-QuickStart
|
||||||
|
|
||||||
|
As an open source project, PackerShift welcomes contributions of many forms.
|
||||||
|
|
||||||
|
Examples of contributions include:
|
||||||
|
|
||||||
|
* Code patches
|
||||||
|
* Documentation improvements
|
||||||
|
* Bug reports and patch reviews
|
||||||
|
|
||||||
|
**Warning: non-trivial pull requests (anything more than fixing a typo) without
|
||||||
|
Trac tickets will be closed!** [Please file a ticket](https://github.com/packershift/cookiecutter-django-quickstart/issues/new/choose) to suggest changes.
|
||||||
|
|
||||||
|
Patches can be submitted as pull requests, but if you don't file a ticket, it's unlikely that we'll notice your contribution.
|
||||||
|
|
||||||
|
## How to Contribute
|
||||||
|
|
||||||
Always happy to get issues identified and pull requests!
|
Always happy to get issues identified and pull requests!
|
||||||
|
|
||||||
## Getting your pull request merged in
|
## Getting your pull request merged in
|
||||||
|
|
||||||
1. Keep it small. The smaller the pull request, the more likely we are to accept.
|
1. Keep it small. The smaller the pull request, the more likely we are to accept.
|
||||||
2. Pull requests that fix a current issue get priority for review.
|
2. Pull requests that fix a current issue get priority for review.
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
|
@ -15,7 +30,9 @@ Please install [tox](https://tox.readthedocs.io/en/latest/), which is a generic
|
||||||
|
|
||||||
[tox](https://tox.readthedocs.io/en/latest/) is available for download from [PyPI](https://pypi.python.org/pypi) via [pip](https://pypi.python.org/pypi/pip/):
|
[tox](https://tox.readthedocs.io/en/latest/) is available for download from [PyPI](https://pypi.python.org/pypi) via [pip](https://pypi.python.org/pypi/pip/):
|
||||||
|
|
||||||
$ pip install tox
|
```
|
||||||
|
pip install tox
|
||||||
|
```
|
||||||
|
|
||||||
It will automatically create a fresh virtual environment and install our test dependencies,
|
It will automatically create a fresh virtual environment and install our test dependencies,
|
||||||
such as [pytest-cookies](https://pypi.python.org/pypi/pytest-cookies/) and [flake8](https://pypi.python.org/pypi/flake8/).
|
such as [pytest-cookies](https://pypi.python.org/pypi/pytest-cookies/) and [flake8](https://pypi.python.org/pypi/flake8/).
|
||||||
|
@ -28,15 +45,25 @@ For further information please consult the [pytest usage docs](https://pytest.or
|
||||||
|
|
||||||
To run all tests using various versions of python in virtualenvs defined in tox.ini, just run tox.:
|
To run all tests using various versions of python in virtualenvs defined in tox.ini, just run tox.:
|
||||||
|
|
||||||
$ tox
|
```python
|
||||||
|
tox
|
||||||
|
```
|
||||||
|
|
||||||
It is possible to test with a specific version of python. To do this, the command
|
It is possible to test with a specific version of python. To do this, the command
|
||||||
is:
|
is:
|
||||||
|
|
||||||
$ tox -e py310
|
```
|
||||||
|
tox -e py310
|
||||||
|
```
|
||||||
|
|
||||||
This will run pytest with the python3.10 interpreter, for example.
|
This will run pytest with the python3.10 interpreter, for example.
|
||||||
|
|
||||||
To run a particular test with tox for against your current Python version:
|
To run a particular test with tox for against your current Python version:
|
||||||
|
|
||||||
$ tox -e py -- -k test_default_configuration
|
```
|
||||||
|
tox -e py -- -k test_default_configuration
|
||||||
|
```
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
As a contributor, you can help us keep the Django community open and inclusive. Please read and follow our [Code of Conduct](<https://github.com/packershift/.github/blob/main/CODE_OF_CONDUCT.md>).
|
||||||
|
|
1811
CONTRIBUTORS.md
1811
CONTRIBUTORS.md
File diff suppressed because it is too large
Load Diff
44
LICENSE
44
LICENSE
|
@ -1,27 +1,29 @@
|
||||||
Copyright (c) 2013-2020, Daniel Roy Greenfeld
|
BSD 3-Clause License
|
||||||
|
|
||||||
|
Copyright (c) 2022, PackerShift.io
|
||||||
All rights reserved.
|
All rights reserved.
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without modification,
|
Redistribution and use in source and binary forms, with or without
|
||||||
are permitted provided that the following conditions are met:
|
modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
* Redistributions of source code must retain the above copyright notice, this
|
1. Redistributions of source code must retain the above copyright notice, this
|
||||||
list of conditions and the following disclaimer.
|
list of conditions and the following disclaimer.
|
||||||
|
|
||||||
* Redistributions in binary form must reproduce the above copyright notice, this
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||||
list of conditions and the following disclaimer in the documentation and/or
|
this list of conditions and the following disclaimer in the documentation
|
||||||
other materials provided with the distribution.
|
and/or other materials provided with the distribution.
|
||||||
|
|
||||||
* Neither the name of Cookiecutter Django nor the names of its contributors may
|
3. Neither the name of the copyright holder nor the names of its
|
||||||
be used to endorse or promote products derived from this software without
|
contributors may be used to endorse or promote products derived from
|
||||||
specific prior written permission.
|
this software without specific prior written permission.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||||
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||||
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
OF THE POSSIBILITY OF SUCH DAMAGE.
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
66
README.md
66
README.md
|
@ -1,10 +1,11 @@
|
||||||
# Cookiecutter Django
|
# Cookiecutter Django
|
||||||
|
|
||||||
[](https://github.com/cookiecutter/cookiecutter-django/actions?query=workflow%3ACI)
|
[](https://github.com/packershift/cookiecutter-django-quickstart/actions?query=workflow%3ACI)
|
||||||
[](https://cookiecutter-django.readthedocs.io/en/latest/?badge=latest)
|
[](https://cookiecutter-django.readthedocs.io/en/latest/?badge=latest)
|
||||||
[](https://pyup.io/repos/github/cookiecutter/cookiecutter-django/)
|
[](https://pyup.io/repos/github/packershift/cookiecutter-django-quickstart/)
|
||||||
[](https://discord.gg/uFXweDQc5a)
|
[](https://pyup.io/repos/github/packershift/cookiecutter-django-quickstart/)
|
||||||
[](https://www.codetriage.com/cookiecutter/cookiecutter-django)
|
[](https://discord.gg/SQTCyMUrms)
|
||||||
|
[](https://www.codetriage.com/packershift/cookiecutter-django-quickstart)
|
||||||
[](https://github.com/ambv/black)
|
[](https://github.com/ambv/black)
|
||||||
|
|
||||||
Powered by [Cookiecutter](https://github.com/cookiecutter/cookiecutter), Cookiecutter Django is a framework for jumpstarting
|
Powered by [Cookiecutter](https://github.com/cookiecutter/cookiecutter), Cookiecutter Django is a framework for jumpstarting
|
||||||
|
@ -12,7 +13,7 @@ production-ready Django projects quickly.
|
||||||
|
|
||||||
- Documentation: <https://cookiecutter-django.readthedocs.io/en/latest/>
|
- Documentation: <https://cookiecutter-django.readthedocs.io/en/latest/>
|
||||||
- See [Troubleshooting](https://cookiecutter-django.readthedocs.io/en/latest/troubleshooting.html) for common errors and obstacles
|
- See [Troubleshooting](https://cookiecutter-django.readthedocs.io/en/latest/troubleshooting.html) for common errors and obstacles
|
||||||
- If you have problems with Cookiecutter Django, please open [issues](https://github.com/cookiecutter/cookiecutter-django/issues/new) don't send
|
- If you have problems with Cookiecutter Django, please open [issues](https://github.com/packershift/cookiecutter-django-quickstart/issues/new) don't send
|
||||||
emails to the maintainers.
|
emails to the maintainers.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
@ -49,25 +50,13 @@ production-ready Django projects quickly.
|
||||||
## Constraints
|
## Constraints
|
||||||
|
|
||||||
- Only maintained 3rd party libraries are used.
|
- Only maintained 3rd party libraries are used.
|
||||||
- Uses PostgreSQL everywhere: 10.19 - 14.1 ([MySQL fork](https://github.com/mabdullahadeel/cookiecutter-django-mysql) also available).
|
|
||||||
- Environment variables for configuration (This won't work with Apache/mod_wsgi).
|
- Environment variables for configuration (This won't work with Apache/mod_wsgi).
|
||||||
|
|
||||||
## Support this Project!
|
## Support this Project!
|
||||||
|
|
||||||
This project is run by volunteers. Please support them in their efforts to maintain and improve Cookiecutter Django:
|
This project is run by volunteers. Please support them in their efforts to maintain and improve Cookiecutter Django:
|
||||||
|
|
||||||
- Daniel Roy Greenfeld, Project Lead ([GitHub](https://github.com/pydanny), [Patreon](https://www.patreon.com/danielroygreenfeld)): expertise in Django and AWS ELB.
|
- Jeh, Project Lead [GitHub](https://github.com/jbanimineni), expertise in Django and DevOps, DevSecOps.
|
||||||
- Nikita Shupeyko, Core Developer ([GitHub](https://github.com/webyneter)): expertise in Python/Django, hands-on DevOps and frontend experience.
|
|
||||||
|
|
||||||
Projects that provide financial support to the maintainers:
|
|
||||||
|
|
||||||
------------------------------------------------------------------------
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://www.feldroy.com/products//two-scoops-of-django-3-x"><img src="https://cdn.shopify.com/s/files/1/0304/6901/products/Two-Scoops-of-Django-3-Alpha-Cover_540x_26507b15-e489-470b-8a97-02773dd498d1_1080x.jpg"></a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
Two Scoops of Django 3.x is the best ice cream-themed Django reference in the universe!
|
|
||||||
|
|
||||||
### PyUp
|
### PyUp
|
||||||
|
|
||||||
|
@ -88,11 +77,11 @@ First, get Cookiecutter. Trust me, it's awesome:
|
||||||
|
|
||||||
Now run it against this repo:
|
Now run it against this repo:
|
||||||
|
|
||||||
$ cookiecutter https://github.com/cookiecutter/cookiecutter-django
|
$ cookiecutter https://github.com/packershift/cookiecutter-django-quickstart
|
||||||
|
|
||||||
You'll be prompted for some values. Provide them, then a Django project will be created for you.
|
You'll be prompted for some values. Provide them, then a Django project will be created for you.
|
||||||
|
|
||||||
**Warning**: After this point, change 'Daniel Greenfeld', 'pydanny', etc to your own information.
|
**Warning**: After this point, change 'packershift', 'Jeh', etc to your own information.
|
||||||
|
|
||||||
Answer the prompts with your own desired [options](http://cookiecutter-django.readthedocs.io/en/latest/project-generation-options.html). For example:
|
Answer the prompts with your own desired [options](http://cookiecutter-django.readthedocs.io/en/latest/project-generation-options.html). For example:
|
||||||
|
|
||||||
|
@ -105,9 +94,9 @@ Answer the prompts with your own desired [options](http://cookiecutter-django.re
|
||||||
project_name [My Awesome Project]: Reddit Clone
|
project_name [My Awesome Project]: Reddit Clone
|
||||||
project_slug [reddit_clone]: reddit
|
project_slug [reddit_clone]: reddit
|
||||||
description [Behold My Awesome Project!]: A reddit clone.
|
description [Behold My Awesome Project!]: A reddit clone.
|
||||||
author_name [Daniel Roy Greenfeld]: Daniel Greenfeld
|
author_name [Jeh]: Jeh
|
||||||
domain_name [example.com]: myreddit.com
|
domain_name [example.com]: myreddit.com
|
||||||
email [daniel-greenfeld@example.com]: pydanny@gmail.com
|
email [help@example.com]: help@example.com
|
||||||
version [0.1.0]: 0.0.1
|
version [0.1.0]: 0.0.1
|
||||||
Select open_source_license:
|
Select open_source_license:
|
||||||
1 - MIT
|
1 - MIT
|
||||||
|
@ -174,7 +163,7 @@ Create a git repo and push it there:
|
||||||
$ git init
|
$ git init
|
||||||
$ git add .
|
$ git add .
|
||||||
$ git commit -m "first awesome commit"
|
$ git commit -m "first awesome commit"
|
||||||
$ git remote add origin git@github.com:pydanny/redditclone.git
|
$ git remote add origin git@github.com:packershift/redditclone.git
|
||||||
$ git push -u origin master
|
$ git push -u origin master
|
||||||
|
|
||||||
Now take a look at your repo. Don't forget to carefully look at the generated README. Awesome, right?
|
Now take a look at your repo. Don't forget to carefully look at the generated README. Awesome, right?
|
||||||
|
@ -186,13 +175,8 @@ For local development, see the following:
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
- Have questions? **Before you ask questions anywhere else**, please post your question on [Stack Overflow](http://stackoverflow.com/questions/tagged/cookiecutter-django) under the *cookiecutter-django* tag. We check there periodically for questions.
|
- If you think you found a bug or want to request a feature, please open an [issue](https://github.com/packershift/cookiecutter-django-quickstart/issues).
|
||||||
- If you think you found a bug or want to request a feature, please open an [issue](https://github.com/cookiecutter/cookiecutter-django/issues).
|
- For anything else, you can chat with us on [Discord](https://discord.gg/SQTCyMUrms).
|
||||||
- For anything else, you can chat with us on [Discord](https://discord.gg/uFXweDQc5a).
|
|
||||||
|
|
||||||
## For Readers of Two Scoops of Django
|
|
||||||
|
|
||||||
You may notice that some elements of this project do not exactly match what we describe in chapter 3. The reason for that is this project, amongst other things, serves as a test bed for trying out new ideas and concepts. Sometimes they work, sometimes they don't, but the end result is that it won't necessarily match precisely what is described in the book I co-authored.
|
|
||||||
|
|
||||||
## For PyUp Users
|
## For PyUp Users
|
||||||
|
|
||||||
|
@ -202,13 +186,9 @@ If you are using [PyUp](https://pyup.io) to keep your dependencies updated and s
|
||||||
|
|
||||||
Scattered throughout the Python and HTML of this project are places marked with "your stuff". This is where third-party libraries are to be integrated with your project.
|
Scattered throughout the Python and HTML of this project are places marked with "your stuff". This is where third-party libraries are to be integrated with your project.
|
||||||
|
|
||||||
## For MySQL users
|
|
||||||
To get full MySQL support in addition to the default Postgresql, you can use this fork of the cookiecutter-django:
|
|
||||||
https://github.com/mabdullahadeel/cookiecutter-django-mysql
|
|
||||||
|
|
||||||
## Releases
|
## Releases
|
||||||
|
|
||||||
Need a stable release? You can find them at <https://github.com/cookiecutter/cookiecutter-django/releases>
|
Need a stable release? You can find them at [Releases](https://github.com/packershift/cookiecutter-django-quickstart/releases)
|
||||||
|
|
||||||
## Not Exactly What You Want?
|
## Not Exactly What You Want?
|
||||||
|
|
||||||
|
@ -229,19 +209,3 @@ If you do rename your fork, I encourage you to submit it to the following places
|
||||||
|
|
||||||
We accept pull requests if they're small, atomic, and make our own project development
|
We accept pull requests if they're small, atomic, and make our own project development
|
||||||
experience better.
|
experience better.
|
||||||
|
|
||||||
## Articles
|
|
||||||
|
|
||||||
- [Cookiecutter Django With Amazon RDS](https://haseeburrehman.com/posts/cookiecutter-django-with-amazon-rds/) - Apr, 2, 2021
|
|
||||||
- [Using cookiecutter-django with Google Cloud Storage](https://ahhda.github.io/cloud/gce/django/2019/03/12/using-django-cookiecutter-cloud-storage.html) - Mar. 12, 2019
|
|
||||||
- [cookiecutter-django with Nginx, Route 53 and ELB](https://msaizar.com/blog/cookiecutter-django-nginx-route-53-and-elb/) - Feb. 12, 2018
|
|
||||||
- [cookiecutter-django and Amazon RDS](https://msaizar.com/blog/cookiecutter-django-and-amazon-rds/) - Feb. 7, 2018
|
|
||||||
- [Using Cookiecutter to Jumpstart a Django Project on Windows with PyCharm](https://joshuahunter.com/posts/using-cookiecutter-to-jumpstart-a-django-project-on-windows-with-pycharm/) - May 19, 2017
|
|
||||||
- [Exploring with Cookiecutter](http://www.snowboardingcoder.com/django/2016/12/03/exploring-with-cookiecutter/) - Dec. 3, 2016
|
|
||||||
- [Introduction to Cookiecutter-Django](http://krzysztofzuraw.com/blog/2016/django-cookiecutter.html) - Feb. 19, 2016
|
|
||||||
- [Django and GitLab - Running Continuous Integration and tests with your FREE account](http://dezoito.github.io/2016/05/11/django-gitlab-continuous-integration-phantomjs.html) - May. 11, 2016
|
|
||||||
- [Development and Deployment of Cookiecutter-Django on Fedora](https://realpython.com/blog/python/development-and-deployment-of-cookiecutter-django-on-fedora/) - Jan. 18, 2016
|
|
||||||
- [Development and Deployment of Cookiecutter-Django via Docker](https://realpython.com/blog/python/development-and-deployment-of-cookiecutter-django-via-docker/) - Dec. 29, 2015
|
|
||||||
- [How to create a Django Application using Cookiecutter and Django 1.8](https://www.swapps.io/blog/how-to-create-a-django-application-using-cookiecutter-and-django-1-8/) - Sept. 12, 2015
|
|
||||||
|
|
||||||
Have a blog or online publication? Write about your cookiecutter-django tips and tricks, then send us a pull request with the link.
|
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
"project_name": "My Awesome Project",
|
"project_name": "My Awesome Project",
|
||||||
"project_slug": "{{ cookiecutter.project_name.lower()|replace(' ', '_')|replace('-', '_')|replace('.', '_')|trim() }}",
|
"project_slug": "{{ cookiecutter.project_name.lower()|replace(' ', '_')|replace('-', '_')|replace('.', '_')|trim() }}",
|
||||||
"description": "Behold My Awesome Project!",
|
"description": "Behold My Awesome Project!",
|
||||||
"author_name": "Daniel Roy Greenfeld",
|
"author_name": "Jeh",
|
||||||
"domain_name": "example.com",
|
"domain_name": "example.com",
|
||||||
"email": "{{ cookiecutter.author_name.lower()|replace(' ', '-') }}@example.com",
|
"email": "{{ cookiecutter.author_name.lower()|replace(' ', '-') }}@example.com",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
|
|
8
setup.py
8
setup.py
|
@ -11,16 +11,16 @@ with open("README.rst") as readme_file:
|
||||||
long_description = readme_file.read()
|
long_description = readme_file.read()
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="cookiecutter-django",
|
name="cookiecutter-django-quickstart",
|
||||||
version=version,
|
version=version,
|
||||||
description=(
|
description=(
|
||||||
"A Cookiecutter template for creating production-ready "
|
"A Cookiecutter template for creating production-ready "
|
||||||
"Django projects quickly."
|
"Django projects quickly."
|
||||||
),
|
),
|
||||||
long_description=long_description,
|
long_description=long_description,
|
||||||
author="Daniel Roy Greenfeld",
|
author="Jeh",
|
||||||
author_email="pydanny@gmail.com",
|
author_email="jbanimineni@packershift.io",
|
||||||
url="https://github.com/cookiecutter/cookiecutter-django",
|
url="https://github.com/cookiecutter/cookiecutter-django-quickstart",
|
||||||
packages=[],
|
packages=[],
|
||||||
license="BSD",
|
license="BSD",
|
||||||
zip_safe=False,
|
zip_safe=False,
|
||||||
|
|
Loading…
Reference in New Issue
Block a user