vint21h / django-djcopyright

Django reusable app to show pretty formatted copyright years

A django-djcopyright documentation

django-djcopyright is a Django reusable application to show pretty formatted copyright years

Contents

• Installation
• Configuration
• Settings
• Usage
• Contributing
• Licensing
• Contacts

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

1. Fork it
2. Install GNU Make
3. Install and configure pyenv and pyenv-virtualenv plugin
4. Install and configure direnv
5. Create environment config from example

cp .env.example .env

6. Install development dependencies:

make install

7. Create your fix/feature branch:

git checkout -b my-new-fix-or-feature

8. Check code style and moreover:

make check

9. Run tests:

make test

10. Push to the branch:

git push origin my-new-fix-or-feature

11. Create a new Pull Request

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 <[email protected]>

For other authors list see AUTHORS file.

django-djcopyright's Issues

May I introduce: https://github.com/arteria/django-copyright

error on djcopyright.context_processors.djcopyright_years

normally the req param must be on
def djcopyright_years(req):
not
def djcopyright_years():

if the param is not there, django throws error