target / make-python-devex

An example Python project using Make, Homebrew, pyenv, poetry, and other great tools

Example repo for Make Python Devex

This repository contains a simple Python® project setup using the Make Python DevEx system described and built by Colin Dean. Read more about why this exists at the Target Tech blog post Make Python DevEx.

Tip

Quickstart: With Homebrew installed and brew available (which brew):

# if you use the gh CLI tool 
gh repo clone target/make-python-devex
# or just git
git clone https://github.com/target/make-python-devex.git
# then set it up, run deps twice in separate invocations
make deps
make deps check test build

Run make help to see the tasks available.

In theory, run make deps until it succeeds, following any instructions output in the meantime. Then, run make check test build to build the distributable. Run poetry run example-make-python-devex to see the app in action.

This system was built for and tested primarily on Apple® macOS® 11 and later. It may work on Linux with adjustments; PRs welcome.

Legal Notices

See LICENSE for licensing information.

"Python" and the Python logos are trademarks or registered trademarks of the Python Software Foundation, used by Target with permission from the Foundation.

make-python-devex's Issues

pin github action SHAs

top-level guidance is coming for this someday, but for now you can review this reference: https://blog.rafaelgss.dev/why-you-should-pin-actions-by-commit-hash

add dependabot

see our internal docs

Add diff-poetry-lock to PR actions for Poetry lock diff improvements

diff-poetry-lock can produce really nice report comments in PRs to show what changed in a poetry.lock.

It's lagging a little behind in updates so let's wait until it supports Poetry 1.7+ before using it.