jbussdieker 0.14.0

A modern Python project generator.

python-jbussdieker

A modern Python project generator — zero to PyPI with automated releases.

🚀 What it does

jbussdieker scaffolds a best-practice Python project with:

• ✅ pyproject.toml using PEP 621
• ✅ GitHub Actions CI for linting, typing, tests, and publishing
• ✅ Makefile with simple install, lint, test commands
• ✅ .gitignore for Python best practices
• ✅ release-please workflow for versioning and changelogs
• ✅ Publish to PyPI using Trusted Publishers

No tokens. No manual uploads. Just push, merge, and release.

📦 Install

pip install jbussdieker --upgrade

🧑‍💻 Create a new project

jbussdieker create myproject
cd myproject
git init
git commit --allow-empty -m "chore: init" # creates initial branch so you can push & configure settings
gh repo create --source=. --private --push
# ⏸️ IMPORTANT: Before pushing real code,
# ensure GitHub Actions permissions are set as described below!
git add .
git commit -m "feat: initial commit"
git push
# Make sure to configure PyPI Trusted Publisher before merging the release PR

✅ Set up automated releases

1️⃣ Ensure GitHub Actions has required permissions

For release-please to work, your repository’s Actions must have write access and permission to create PRs.

• Allow workflows to write to your repo:

  • Go to your repo’s Settings → Actions → General (GitHub Actions settings)
  • Under Workflow permissions, select Read and write permissions

• Allow Actions to create PRs:

  • In the same Actions settings
  • Check Allow GitHub Actions to create and approve pull requests

These are required so the workflows can open changelog PRs and publish your releases automatically.

2️⃣ Add a Trusted Publisher on PyPI

Configure PyPI to trust your GitHub repo for publishing

• Visit PyPI Publishing

• Scroll down to add a new pending publisher

• Fill out:

  • GitHub Owner → your username or org

  • Repository Name → your repo name (myproject)

  • Workflow Name →

    publish.yml
    

  • Environment Name →

    release
    

• Click Add.

Note: The generated publish.yml uses an environment named release by default. You can edit or remove this later — just keep it in sync with your PyPI settings.

3️⃣ Push your first tag

Once release-please opens a version bump PR, merging it will automatically publish your package. No API keys needed — PyPI trusts your GitHub Action.

Want to learn more? See the release-please GitHub repo.

🧹 Local development

Your project includes a simple Makefile:

make venv    # create .venv
make install # pip install -e .
make lint    # black + mypy
make format  # run black
make test    # run unittest
make clean   # remove .venv

🔒 Recommended GitHub repo settings

• ✅ Use Squash merge only — keeps your history tidy and is required for a linear commit history. See why release-please recommends this.
• ✅ Enable Auto-delete branches after merge

📢 Example workflow

# 1️⃣ Scaffold the project locally
jbussdieker create myproject
cd myproject

# 2️⃣ Init the repo with an empty commit to push just the structure
git init
git commit --allow-empty -m "chore: init"  # ensures a branch exists for first push
gh repo create --source=. --public --push

# ⏸️ This step ensures your repo exists on GitHub first,
# so you can safely configure required Actions + PyPI before any workflows run!

# 3️⃣ Now pause — go to GitHub and:
#    ✅ Set Workflow permissions to Read & Write
#    ✅ Allow Actions to create & approve PRs
#    ✅ Add PyPI Trusted Publisher if you like

# 4️⃣ Add the actual files
git add .
git commit -m "feat: initial code"
git push

# 5️⃣ Merge your first release-please PR 🚀

📝 License

This project is licensed under MIT.

🎉 Ship faster

No config sprawl. No secrets rotation. Just git push and publish Python packages the modern way.

---

Enjoy! 🚀