its_my_party

Summary

Sets up a new development environment for a Mac or Linux (i.e., UNIX) box.

Table of Contents

• its_my_party
  • Summary
  • Setup
  • Quickstart
  • Development
  • TODO
  • Further Reading

Setup

• Minimum requirements
  • Python 3.11
• Dev dependencies
  • make
    • Linux
    • macOS
  • editorconfig
  • wsl

Quickstart

• Install python and tooling

  # install python and dependencies (e.g., git, ansible, etc.)
  ./bootstrap install

• Run server

  # script
  ./bootstrap run
  
  # manual
  gunicorn -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000 app:app --reload

Development

• asdf

  asdf install

• poetry

  # install dependencies
  poetry install
  
  # shell
  poetry shell
  
  # run
  poetry run python app.py
  
  # deactivate
  exit

• ./boostrap commands

  # update pyproject.toml and poetry.lock
  ./bootstrap bump-deps
  
  # export requirements.txt
  ./bootstrap export-reqs
  
  # install git hooks
  ./bootstrap install-precommit
  
  # update git hooks
  ./bootstrap update-precommit

• conventional commits

  # install commitizen
  npm install -g commitizen
  commitizen init cz-conventional-changelog --save-dev --save-exact
  
  # commit
  git add .
  
  # commitizen
  git cz

TODO

• Open Issues
• Write boilerplate pytest tests
• CI/CD

Further Reading

• python
• asdf
• poetry
• docker-compose
• pre-commit hooks