معرفی شرکت ها
django-project-version-0.9.4
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Django reusable app to show your project version
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | django-project-version-0.9.4 |
| نام | django-project-version |
| نسخه کتابخانه | 0.9.4 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | DCOD |
| ایمیل نویسنده | contact@d-cod.com |
| آدرس صفحه اصلی | https://github.com/DCOD-OpenSource/django-project-version/ |
| آدرس اینترنتی | https://pypi.org/project/django-project-version/ |
| مجوز | MIT |
A django-project-version documentation
======================================
|GitHub|_ |Coveralls|_ |pypi-license|_ |pypi-version|_ |pypi-python-version|_ |pypi-django-version|_ |pypi-format|_ |pypi-wheel|_ |pypi-status|_
*django-project-version is a Django reusable app to show your project version*
.. contents::
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``.
.. code-block:: python
# 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``
.. code-block:: python
# settings.py
TEMPLATE_CONTEXT_PROCESSORS += [
"djversion.context_processors.version",
]
Or you can use ``project_version`` templatetag which can be loaded from ``djversion_tags``.
.. code-block:: django
{# 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: ``$ django-admin print-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"``.
.. code-block:: python
# settings.py
INSTALLED_APPS += [
"rest_framework",
]
* Add ``"djversion"`` to your URLs definitions:
.. code-block:: python
# urls.py
from django.urls import re_path, include
urlpatterns += [
re_path(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.
Contributing
------------
- `Fork it <https://github.com/DCOD-OpenSource/django-project-version/>`_
- Install `GNU Make <https://www.gnu.org/software/make/>`_
- Install and configure `pyenv <https://github.com/pyenv/pyenv/>`_ and `pyenv-virtualenv plugin <https://github.com/pyenv/pyenv-virtualenv/>`_
- Install and configure `direnv <https://github.com/direnv/direnv/>`_
- Create environment config from example
.. code-block:: bash
cp .env.example .env
- Install development dependencies:
.. code-block:: bash
make install
- Create your fix/feature branch:
.. code-block:: bash
git checkout -b my-new-fix-or-feature
- Check code style and moreover:
.. code-block:: bash
make check
- Run tests:
.. code-block:: bash
make test
- Push to the branch:
.. code-block:: bash
git push origin my-new-fix-or-feature
- `Create a new Pull Request <https://github.com/DCOD-OpenSource/django-project-version/compare/>`_
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 contributors list see CONTRIBUTORS file.
.. |GitHub| image:: https://github.com/DCOD-OpenSource/django-project-version/workflows/build/badge.svg
:alt: GitHub
.. |Coveralls| image:: https://coveralls.io/repos/github/DCOD-OpenSource/django-project-version/badge.svg?branch=master
:alt: Coveralls
.. |pypi-license| image:: https://img.shields.io/pypi/l/django-project-version
:alt: License
.. |pypi-version| image:: https://img.shields.io/pypi/v/django-project-version
:alt: Version
.. |pypi-django-version| image:: https://img.shields.io/pypi/djversions/django-project-version
:alt: Supported Django version
.. |pypi-python-version| image:: https://img.shields.io/pypi/pyversions/django-project-version
:alt: Supported Python version
.. |pypi-format| image:: https://img.shields.io/pypi/format/django-project-version
:alt: Package format
.. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/django-project-version
:alt: Python wheel support
.. |pypi-status| image:: https://img.shields.io/pypi/status/django-project-version
:alt: Package status
.. _GitHub: https://github.com/DCOD-OpenSource/django-project-version/actions/
.. _Coveralls: https://coveralls.io/github/DCOD-OpenSource/django-project-version?branch=master
.. _pypi-license: https://pypi.org/project/django-project-version/
.. _pypi-version: https://pypi.org/project/django-project-version/
.. _pypi-django-version: https://pypi.org/project/django-project-version/
.. _pypi-python-version: https://pypi.org/project/django-project-version/
.. _pypi-format: https://pypi.org/project/django-project-version/
.. _pypi-wheel: https://pypi.org/project/django-project-version/
.. _pypi-status: https://pypi.org/project/django-project-version/
نیازمندی
| مقدار | نام |
|---|---|
| <4.2,>=2.2 | django |
| >=1.0.3 | django-appconf |
| >=3.0.2 | gitpython |
| >=3.10.3 | djangorestframework |
| ==22.2.0 | attrs |
| ==1.7.5 | bandit |
| ==23.1.0 | black |
| ==0.49 | check-manifest |
| ==0.4.0 | check-wheel-contents |
| ==6.5.0 | coverage |
| ==3.3.1 | coveralls |
| ==0.13.1 | curlylint |
| ==1.8.1 | darglint |
| ==1.1.0 | dennis |
| ==1.15.0 | django-stubs |
| ==1.9.1 | djangorestframework-stubs |
| ==0.14.0 | dlint |
| ==0.2.1 | dodgy |
| ==0.4.0 | dotenv-linter |
| ==0.0.7 | flake8-annotations-complexity |
| ==0.0.6 | flake8-annotations-coverage |
| ==0.6.0 | flake8-broken-line |
| ==23.3.12 | flake8-bugbear |
| ==2.1.0 | flake8-builtins |
| ==1.3.2 | flake8-coding |
| ==0.1.0 | flake8-cognitive-complexity |
| ==3.10.1 | flake8-comprehensions |
| ==4.1.2 | flake8-debugger |
| ==1.1.5 | flake8-django |
| ==1.7.0 | flake8-docstrings |
| ==1.4.0 | flake8-eradicate |
| ==2.1.3 | flake8-executable |
| ==0.0.11 | flake8-expression-complexity |
| ==1.1.1 | flake8-fixme |
| ==0.0.7 | flake8-functions |
| ==1.2.0 | flake8-mutable |
| ==0.3.4 | flake8-no-implicit-concat |
| ==5.0.0 | flake8-print |
| ==1.2.0 | flake8-return |
| ==0.19.3 | flake8-simplify |
| ==0.28.0 | flake8-spellcheck |
| ==1.14.0 | flake8-typing-imports |
| ==1.4 | flake8-use-fstring |
| ==0.0.5 | flake8-variables-names |
| ==5.0.4 | flake8 |
| ==6.00 | importlib-metadata |
| ==1.5.0 | interrogate |
| ==5.12.0 | isort |
| ==1.1.1 | mypy |
| ==0.13.3 | pep8-naming |
| ==0.7.3 | perflint |
| ==0.6.0 | pip-outdated |
| ==0.4 | polint |
| ==4.4.0 | pre-commit-hooks |
| ==3.1.1 | pre-commit |
| ==2.14.0 | pygments |
| ==2.5.3 | pylint-django |
| ==2.17.0 | pylint |
| ==4.2 | pyroma |
| ==4.0.0 | pytest-cov |
| ==4.5.2 | pytest-django |
| ==0.1.3 | pytest-extra-durations |
| ==0.4.2 | pytest-instafail |
| ==0.9.6 | pytest-sugar |
| ==0.0.11 | pytest-timer[termcolor] |
| ==7.2.2 | pytest |
| ==0.9.9 | pymarkdownlnt |
| ==37.3 | readme-renderer |
| ==1.3.1 | removestar |
| ==6.1.2 | rstcheck |
| ==2.2.0 | seed-isort-config |
| ==0.9.0 | tabulate |
| ==2.12.0 | tox-gh-actions |
| ==1.1.0 | tox-pyenv |
| ==3.28.0 | tox |
| ==4.0.2 | twine |
| ==0.40.0 | wheel |
| ==1.4.0 | yesqa |
نحوه نصب
نصب پکیج whl django-project-version-0.9.4:
pip install django-project-version-0.9.4.whl
نصب پکیج tar.gz django-project-version-0.9.4:
pip install django-project-version-0.9.4.tar.gz