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.2.zip
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cf1133f85e2d7f61be5e867080cb825e950b3dae263ba797f536b7788156cd6 |
|
MD5 | 19b842176f3e915b1d7fae54c78177e9 |
|
BLAKE2b-256 | b552d785304524134d2dcc7506e7f714f4c726f2392c47a1549b16f6005e93c8 |
Hashes for django_project_version-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa8e38b34528d9f61e702eb3da0a3a25ac1a6efb662855a1f8b2cd981dc61933 |
|
MD5 | f4df2e28092b2d8dad9dc52ff10a0ee4 |
|
BLAKE2b-256 | 3277dcfe4b1be77a94855fafd4ac830a27e669defdc846c018ecfc88e37abc0e |