Djangolib
Installation
pip install unicef-djangolib
Setup
Add unicef_djangolib
to INSTALLED_APPS
in settings
INSTALLED_APPS = [
...
'unicef_djangolib',
]
Configure the html elements for display:
NAME = os.environ.get('NAME', 'default_name')
VERSION = os.environ.get('VERSION', 'default_version')
BACKGROUND_COLOR = os.environ.get('HEADER_BG_COLOR', '#42515A')
HEADER_RIGHT_LOGO = os.environ.get('HEADER_RIGHT_LOGO', "/static/images/default_right.svg")
HEADER_LEFT_LOGO = os.environ.get('HEADER_LEFT_LOGO', "/static/images/default_left.svg")
FOOTER_LOGO = os.environ.get('FOOTER_LOGO', "/static/images/default_footer_logo.png")
Usage
TODO
Contributing
Environment Setup
To install the necessary libraries
$ make install
Coding Standards
See PEP 8 Style Guide for Python Code for complete details on the coding standards.
To run checks on the code to ensure code is in compliance
$ make lint
Testing
Testing is important and tests are located in tests/ directory and can be run with;
$ make test
Coverage report is viewable in build/coverage directory, and can be generated with;
Project Links
- Continuous Integration - https://circleci.com/gh/unicef/unicef-djangolib/tree/develop
- Source Code - https://github.com/unicef/unicef-djangolib
Links
Stable | |||
Development | |||
Source Code | https://github.com/unicef/unicef-djangolib | ||
Issue tracker | https://github.com/unicef/unicef-djangolib/issues |