Django-LibReports

Django app to allow creating custom reports easily.

Overview

Django app to allow creating custom reports easily..

Requirements

• Python (3.8)
• Django (3.2+)
• python-dateutil
• pychrome
• django-celery-beat
• pypandoc
• Chrome or Chromium web browser

Installation

Install using pip...

aws --profile production codeartifact login --tool pip --domain criticalstart --domain-owner 818476207984 --repository criticalstart_global
pip install django-libreport

Example settings:

CHROME_URL = 'http://localhost:9222'
ORGANIZATION_MODEL = 'myapp.Organization'
REPORT_PACKAGES = ('myapp.reports', )  # Packages were reports can be found
INSTALLED_APPS = (
    ...
    'django_celery_beat',
    'reports',
)

For generating PDF reports you must have a Chrome/Chromium browser instance running:

google-chrome --remote-debugging-port=9222

or headless mode:

google-chrome --headless --disable-gpu --remote-debugging-port=9222

You will then have to create an API to manage these. More docs to come...

That's it, we're done!

Development

Setting up

Setup dependencies

pip install -r requirements.txt

Running tests

python3 reports/runtests/runtests.py

Adding requirements to requirements-build.in

Make sure when you run pip-compile, you add the --no-emit-index-url flag, to prevent the CodeArtifact token from being committed to source control:

pip-compile --no-emit-index-url requirements-build.in
pip install -r requirements-build.txt

Deploying

python -m build
aws --profile production codeartifact login --tool twine --domain criticalstart --domain-owner 818476207984 --repository criticalstart_global
twine upload --repository codeartifact dist/*