pyoupyou is a recruitment management software that make life easier for all people involved in the recruitment process
pyoupyou is available under the GNU Affero Public License v3 or newer (AGPL 3+). http://www.gnu.org/licenses/agpl-3.0.html
- Python ~= 3.9
- poetry == 1.4.0
poetry install --with dev
- poetry install
To contribute do Pull Request against this repository (https://github.com/pyoupyou/pyoupyou)
In order to create a branch from an issue use github name suggestion -issue-name
We use black to enforce coding style, you just need to run black . before commiting.
To format string using format will be prefered over the % syntax. In order to facilitate translation we will use named placeholder
"This is a {state} example".format(state="good")
# Switch to poetry
poetry shell
# set environment to dev, will load settings in pyoupyou/settings/dev.py
export PYOUPYOU_ENV=dev
# Migrate Database, create schema ....
python manage.py migrate
# Cleanup all data in database
python manage.py flush
# Generate dev dataset
python manage.py create_dev_dataset
# launch the dev server
python manage.py runserver
# pyoupyou is now launched at http://127.0.0.1:8000/
Based on local.py.example create a local.py file containing keys referenced by local.py.example and database configuration.
https://docs.djangoproject.com/en/2.2/ref/settings/#databases
# install dependencies
export PIPENV_VENV_IN_PROJECT=true # To create virtualenv on the project folder under .venv
poetry install
# collect static files
PYOUPYOU_ENV="prod" poetry run ./manage.py collectstatic
# migrate database
PYOUPYOU_ENV="prod" poetry run ./manage.py migrate
In order to run it you can use a wsgi capable webserver (apache mod_wsgi, gunicorn, uWSGI...), ensure to set PYOUPYOU_ENV variable to prod or dev.
As an alternative you can also set name in pyoupyou/.pyoupyou_env file.