Main functionalities for the curator core project
Project description
This Django reusable app contains the main functionalities for the curator core project.
Pre-requisites
For automated and manual install, the following software are needed:
python
pip
virtual env (conda or venv)
In addition, for manual setup, git is needed.
Installation
Automated installation
$ pip install core_main_app
Manual installation
$ git clone https://github.com/usnistgov/core_main_app.git
$ cd core_main_app
$ python setup.py
$ pip install sdist/*.tar.gz
Configuration
Edit the setting.py file
Add the "core_main_app" and "tz_detect" under INSTALLED_APPS as such:
INSTALLED_APPS = [
...
"tz_detect",
"core_main_app",
]
Add the middleware required by tz_detect:
MIDDLEWARE = (
...
'tz_detect.middleware.TimezoneMiddleware',
)
Edit the urls.py file
Add the core_main_app urls to the Django project as such.
url(r'^', include("core_main_app.urls")),
Internationalization (i18n)
Before running the project, don’t forget to compile the translation file at project level. i18n uses the gettext package, so please make sure it is installed prior to using this command.
$ python manage.py compilemessages
Tests
To play the test suite created for this package, download the git repository and run:
$ python runtests.py
Documentation
Documentation has been generated using Sphinx. To generate a local version of the docs, please clone the repository and run:
$ cd docs/
$ make html
Or, directly using Sphinx:
$ cd docs/
$ sphinx-build -b html . ../dist/_docs
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.