Django reusable app to show pretty formatted copyright years
Project description
django-djcopyright is a Django reusable application to show pretty formatted copyright years
Installation
Obtain your copy of source code from the git repository: $ git clone https://github.com/vint21h/django-djcopyright.git. Or download the latest release from https://github.com/vint21h/django-djcopyright/tags/.
Run $ python ./setup.py install from the repository source tree or unpacked archive. Or use pip: $ pip install django-djcopyright.
Configuration
Add "djcopyright" to settings.INSTALLED_APPS.
# settings.py
INSTALLED_APPS += [
"djcopyright",
]
Settings
- DJCOPYRIGHT_START_YEAR
Contains year to start show copyright from. Defaults to 1970.
- DJCOPYRIGHT_FORMAT_STRING
Contains format string to show copyright. Defaults to "{start_year} - {current_year}".
- DJCOPYRIGHT_SHOW_CURRENT_YEAR
Show current year in copyright string. Defaults to True.
- DJCOPYRIGHT_SHOW_START_YEAR
Show start year in copyright string. Defaults to True.
Usage
If you want always have "COPYRIGHT_YEARS" variable in templates context, just add "djcopyright.context_processors.djcopyright_years" to settings.TEMPLATE_CONTEXT_PROCESSORS
# settings.py
TEMPLATE_CONTEXT_PROCESSORS += [
"djcopyright.context_processors.djcopyright_years",
]
Else you can use djcopyright_years templatetag which can be loaded from djcopyright_tags.
{# footer.html #}
{% load djcopyright_tags %}
{% djcopyright_years as COPYRIGHT_YEARS %}
{{ COPYRIGHT_YEARS }}
Contributing
Install GNU Make
Install and configure pyenv and pyenv-virtualenv plugin
Install and configure direnv
Create environment config from example
cp .env.example .env
Install development dependencies:
make install
Create your fix/feature branch:
git checkout -b my-new-fix-or-feature
Check code style and moreover:
make check
Run tests:
make test
Push to the branch:
git push origin my-new-fix-or-feature
Licensing
django-djcopyright is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. For complete license text see COPYING file.
Contacts
Project Website: https://github.com/vint21h/django-djcopyright/
Author: Alexei Andrushievich <vint21h@vint21h.pp.ua>
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_djcopyright-0.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fae7f17a6b3cb6e8b3e94b654302a0905fa6fbbc0f654081cbe9f6101a3e402 |
|
MD5 | 6f21f7afc5596a818284085cdc2eddef |
|
BLAKE2b-256 | 4030de96093f16f3c34d6b3e485ec51c88966a206023317a685568a9d8777df9 |