Django reusable app to show your project version
Project description
django-project-version is a Django reusable app to show your project version
Installation
Obtain your copy of source code from the git repository: git clone https://github.com/DCOD-OpenSource/django-project-version.git. Or download the latest release from https://github.com/DCOD-OpenSource/django-project-version/tags/.
Run python ./setup.py install from the repository source tree or unpacked archive. Or use pip: pip install django-project-version.
Configuration
Add "djversion" to settings.INSTALLED_APPS.
# settings.py
INSTALLED_APPS += (
"djversion",
)
django-project-version settings
- DJVERSION_VERSION
Contains project version. Defaults to None.
- DJVERSION_UPDATED
Contains project update date or datetime. Defaults to None.
- DJVERSION_FORMAT_STRING
Contains version and updated format string. Defaults to "{version} ({updated})".
- DJVERSION_GIT_REPO_PATH
Contains path to git repository from where version info can get. Defaults to None.
- DJVERSION_GIT_USE_TAG
Indicate usage of git repository current tag as project version. Defaults to False.
- DJVERSION_GIT_USE_COMMIT
Indicate usage of git repository last commit hash as project version. Defaults to False.
Usage
If you want always have "VERSION" variable in templates context, just add "djversion.context_processors.version" to settings.TEMPLATE_CONTEXT_PROCESSORS
# settings.py
TEMPLATE_CONTEXT_PROCESSORS += (
"djversion.context_processors.version",
)
Or you can use project_version templatetag which can be loaded from djversion_tags.
{# footer.html #}
{% load djversion_tags %}
{% project_version as VERSION %}
{{ VERSION }}
Advanced features
If you want to have REST-style view with your project version:
Install django-project-version with additional dependencies: pip install django-project-version[rest].
Extend you settings.INSTALLED_APPS by adding "rest_framework".
# settings.py
INSTALLED_APPS += (
"rest_framework",
)
Add "djversion" to your URLs definitions:
# urls.py
urlpatterns += [
url(r"^version/", include("djversion.urls")),
]
Or to use information from the project git repository as project version:
Install django-project-version with additional dependencies: pip install django-project-version[git].
Configure git related settings.
Licensing
django-project-version uses the MIT license. Please check the MIT-LICENSE file for more details.
Contacts
Project Website: https://github.com/DCOD-OpenSource/django-project-version/
Author: DCOD <contact@d-cod.com>
For other authors list see AUTHORS file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-project-version-0.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49b46a0519bd328a25f8c0f2e9539f21467198150b4dbfdcceb166e4a973c243 |
|
MD5 | 320d02e230aa8837b0ce91a61875fee3 |
|
BLAKE2b-256 | edada5f106883e9149138f584e13fe425ddb040a3ab1a17ca8fa698c6c8a9aee |
Hashes for django_project_version-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 630b67f2ef23fb41b1bfd9d5998e7180cd696903469fa0ae2ea5379ab886760c |
|
MD5 | b48c8fe9370c302f48ea12fe1ae045c4 |
|
BLAKE2b-256 | 7ec1518813a1313c97f0cc994a794248ab27dd2199466cb3438021793f6860bb |