Skip to content

First-run documentation and Poetry for localdev dependency management

Derrick Liu requested to merge svdsa/membership_api:lediur/first-run into dev

@DSASanFrancisco/portal-members

This PR adds a Poetry pyproject.toml file, a poetry.lock file, and instructions on how to use Poetry to set up a local development environment (chiefly to make editor tooling happy).

I haven't gone through and removed the requirements.txt or anything like that yet, but we may want to consider using it for dependency management even for building the Docker images.

I have:

  • Included a summary of the changes
  • Linked all relevant Trello tickets to this request
  • Linked all relevant GitLab issues to this request (optional -- prefer Trello, but GitLab is easier for fast-follow cleanup issues)
  • Listed all dependent merge requests in this summary (optional)

Merge Request Rules

Author

  • If the MR isn't finished, prepend "WIP" to the title.
  • Unless otherwise noted, you should merge after approval.

Reviewer

  • Comments aren't necessarily blockers but can be. Add [blocker], or something similar, to a comment as necessary, otherwise the author may not know what's a blocker and what's not.
  • Bias toward approving the MR and ask for follow-up work as needed. You can make these issues as needed.
  • Be proactive about approving. If you and other reviewers make comments, and yours are resolved by the author, use your judgement to either approve or follow up with the other reviewers. Again, bias toward approving.

Merge request reports