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",
]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 }}Also simple management command print-version which prints project version to stdout is available. Just run: $ python ./manage.py print-version from project folder.
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
from django.conf.urls import url
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.
1 maintainer
Release files for django-project-version 0.11.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django-project-version-0.11.2.zip | 21.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_project_version-0.11.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 34.7 kB
Release files / django-project-version-0.11.2.zip
| Download URL | django-project-version-0.11.2.zip |
|---|---|
| Size | 21.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cb4efec848905430c99ef90bf525cf8743ec0c31842942f13265dd0477cdee6a
|
|
BLAKE2b-256 checksum How to use checksums |
328757e99fd2c748465d5d2b15be1e304e9cbaac45397b9c70670cf6b638b56b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
|
Release files / django_project_version-0.11.2-py3-none-any.whl
| Download URL | django_project_version-0.11.2-py3-none-any.whl |
|---|---|
| Size | 12.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eb0468915c7d58278f38fe108b42c916313bb4f5802266610edb4431cfd8c03a
|
|
BLAKE2b-256 checksum How to use checksums |
5ebe81d3fa9ca4a09139d4430c6d5072f6748a5d1dd6f6e6fe9c3a7b0d90f922
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2
|
