Skip to main content

Django reusable app to show your project version

Project description

Travis Coveralls Requires License Version Supported Python version Supported Django version Package format Python wheel support Package status

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-project-version, version 0.10.5
Filename, size File type Python version Upload date Hashes
Filename, size django_project_version-0.10.5-py3-none-any.whl (12.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-project-version-0.10.5.zip (21.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page