We welcome contributions to this project! Our issue tracker has open bugs, feature requests, etc. We encourage you to introduce yourself to the community in our forums before leaping into action.
All contributors must agree to abide by our Code of Conduct.
In order to run this site locally, you'll want to clone this repository and install the requirements (check the Mac Troubleshooting section if you face any errors):
git clone https://github.com/psf/python-in-edu.git
cd python-in-edu
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
You can then change directories into the python-in-edu folder and build the database:
python manage.py migrate
To run the project locally, run the following command in the terminal:
python manage.py runserver
If you use heroku cli installed on your system, simply run:
heroku local
To test, run:
python manage.py test
If you want to use or test email functionality locally, you'll need to run a simple SMTP server:
python -m smtpd -n -c DebuggingServer localhost:1025
If you don't have an installation of Postgres on your system, you might run into the following error:
Error: pg_config executable not found.
Install Postgres to resolve this issue.
If your Pillow installation fails during installing the requirements with the following message:
The headers or library files could not be found for jpeg,
a required dependency when compiling Pillow from source.