README.md

mvp

minimum viable python

Summary

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

Table of Contents

• mvp
  • 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

Development

# install tools and runtimes (cf. xcode, brew, asdf, poetry, etc.)
./bootstrap <run|run-dev>   # dev only runs plays w/tags and is verbose

# install git hooks
./bootstrap install-precommit

# update git hooks
./bootstrap update-precommit

TODO

• Open Issues
• QA Ansible playbook
  • Test
    • macOS
    • Ubuntu
• Write boilerplate pytest tests
• CI/CD

Further Reading

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