This is an app written for Rethink Charity to automate the generation of tax receipt pdfs for donors.
git clone https://github.com/rtcharity/receipt_generator_app
python -m venv path/to/new/virtual/environment
pip install -r requirements.txt
Check that the virtual environment is using python 3.6 or higher. Set the environment variables (SECRET_KEY, SENDGRID_API_KEY)
Make sure your virtual environment is activated, then:
python manage.py test
To run a specific test file:
python manage.py test functional_tests.test_create_donation
...where 'test_create_donation.py' is the filename.
You may need to install geckodriver to use tests on Firefox.
As of 29th May 2019 a lot of tests produce a ConnectionAbortedError as a result of a Python bug which will be fixed in 3.7.4 (scheduled June 24). python/cpython#9713
projectname/settings.py will detect whether you are local or on Azure hosting so that there is no need to manually specify a new database configuration for local development.
Make sure your virtual environment is activated, then:
python manage.py migrate
This migrate command creates an empty database.
If admin site css is missing, python3.6 manage.py collectstatic
Make sure your virtual environment is activated, then:
python manage.py runserver
(Add 8080 to command if using Amazon Web Services IDE.)
You may need to add the host url to ALLOWED_HOSTS in settings.py if not using localhost.
python manage.py createsuperuser
Define the required details for the admin account. Anyone who can edit the source code of the website and deploy can create an admin account in this way.
Environment variables you will need to set:
- SENDGRID_API_KEY (from https://app.sendgrid.com/settings/api_keys which is protected by log in details)
- SECRET_KEY (specific to each Django project - ask for this on Slack)
- DATABASE_NAME e.g. testdb
- DATABASE_USER e.g. manager@your-database-server
- DATABASE_PASSWORD e.g. supersecretpassword
- DATABASE_HOST e.g. your-database-server.postgres.database.azure.com
Azure should set this automatically:
- WEBSITE_SITE_NAME
These resources may be useful: https://docs.microsoft.com/en-us/azure/app-service/containers/tutorial-python-postgresql-app https://docs.microsoft.com/en-us/azure/app-service/containers/quickstart-docker-go
If you need to enable user authentication, simply add the following line to receipt_generator/views.py:
from django.contrib.auth.decorators import login_required
...and add @login_required above any relevant view method.
Login as admin is required to add a new charity, using the admin site of the site. See here.
Set DEBUG=True in projectname/settings.py. Remove the error-catching 'try/except/else' sequences from receipt_generator/views.py.