django-package-boilerplate

Current version: 0.1.3

Boilerplate for a Django Package

1. Installation

The preferred installation method is directly from pypi:

# Create promgen setting directory.
$ pip install -U django-package-boilerplate

2. Quickstart

In settings.py:

INSTALLED_APPS = [
    ...,
    'django_package_boilerplate'
]

2. In urls.py:

from django.urls import path, include

urlpatterns = [
    ...,
    path('django_package_app/', include('django_package_boilerplate.urls')),
]

3. Run python manage.py migrate Create the models.

$ python manage.py migrate

3. Configuration

• Language setting: Todo

4. Update Package

In setup.cfg, upgrade version

[metadata]
name = django-package-boilerplate
version = x.x.x
...

Build package

$ python setup.py sdist bdist_wheel

Deploy package

$ twine upload --verbose dist/django-package-boilerplate-x.x.x.tar.gz

The MIT License

Copyright (c) 2023 Runners Co., Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.