adding prod and dev requirements for the backend

[to-sta]

Contributor checklist

• This pull request is on a separate branch and not the main branch

---

Description

In this PR, I seperated development requirements and production requirements for the backend with pip-tools. I adjusted the backend workflow/dockerfile to use the development requirements (requirements-dev.txt).

General setup for this, min. requirements are in requirements.in and additional req. for the develpment are in requirements-dev.in. They are compiled to requirements.txt and requiements-dev.txt (including referenced packages).

For example the djangorestframework is part of the requirements.in file and when compiled will reference necessary packages via comment in the requirements.txt file.

pytz==2023.3.post1
    # via djangorestframework

I have tested to run docker-compose up --build with both requirements.

Before we consider merging this, we should update the readme and/or contrib. guide 😄. Mention how to use pip-tools, pip-compile and pip-sync.

Related issue

• Splitting development and production requirements.txt #450

[github-actions]

Thank you for the pull request!

The activist team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Development rooms once you're in. It'd be great to have you!

Maintainer checklist

• The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution

  • The contributor's name and icon in remote commits should be the same as what appears in the PR
  • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local activist repo

• The TypeScript and formatting workflows within the PR checks do not indicate new errors in the files changed

• The CHANGELOG has been updated with a description of the changes for the upcoming release (if necessary)

[netlify]

✅ Deploy Preview for activist-org canceled.

Name	Link
🔨 Latest commit	2d76e7a
🔍 Latest deploy log	https://app.netlify.com/sites/activist-org/deploys/6537ac5bfcee76000856ca3b

[andrewtavis]

Let's discuss this in the dev sync, @to-sta, and then we can finalize the readme/contributing guide :) Feel free to send along an idea of what the changes to those should be though!

[to-sta]

@andrewtavis made a description here about the seperation of production and development. I am not sure where to place it in the contrib. guide. It's relevant when we need to switch between prod and dev and for installing new packages or testing.

In our backend development, we maintain a clean and efficient environment by separating production and development requirements. This is achieved using pip-tools, a set of command line tools designed to keep our pip-based packages fresh, even when we’ve pinned them.

We create two different requirement files: requirements.in for production and requirements-dev.in for development. The production requirements contain the packages that our project needs to run, while the development requirements include additional packages necessary for testing, linting, and other backend development processes.

To compile these .in files into .txt files that pip can understand, we use the pip-compile command from pip-tools. This creates requirements.txt and requirements-dev.txt, which are used to install packages in their respective environments.

To transition between the production and development environments, you can simply use the following commands:

For the production environment:

pip-sync requirements.txt

For the development environment:

pip-sync dev-requirements.txt

Let me know what you think?

[andrewtavis]

Can you fix the merge conflict here @to-sta and I'll merge it in? :)

[to-sta]

Merge conflict is resolved and I also added django-cors-headers to the requirements.in and requirements.txt file. That was still missing. The mypy step in the ci_backend check discovered the missing package 😃

[andrewtavis]

Thanks so much for this, @to-sta! I keep on saying that the dev setup is getting so good and then it keeps getting better! 😊🚀