Skip to main content

A starter project for quickly setting up new Python apps

Project description

Python Starter

Steps to set up

  1. Create a new repository in GitHub using this repository as a template
  2. Generate Docker Hub PAT (Personal Access Token)
  3. Create an Environment in GitHub with the following secrets
    • DOCKER_USERNAME (Docker Hub username)
    • DOCKER_PASSWORD (Docker Hub PAT)
  4. Create a Docker Hub repository with the same name as the GitHub repository
  5. Update assignees in renovate.json with your GitHub username
  6. Set up code-cove and make sure it has access to this repository
  7. Setup branch protection rules
    • Set Enrforcment Status to Enabled
    • Make sure Target branches set to main or default branch
    • Ensure these Branch rules are selected
      • Restrict deletions
      • Require status checks to pass with these checks
        • Lint
        • Test
      • Block force pushes
  8. Create a PyPi Trusted Publisher
  9. Ensure the name in pyproject.toml matches the name of the package on PyPi
  10. Make sure the following linters are installed externally of the project
    • yamllint
    • shellcheck
    • shfmt
    • node (npx/dclint)

TODO

  • Handle GitHub pre-release
  • Update PYTHONPATH with src folder
  • Add custom user to Dockerfile
  • Fix Dockerfile
  • Fix health check
  • Fix version number

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

js_python_starter-20260430001548.dev0.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

js_python_starter-20260430001548.dev0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file js_python_starter-20260430001548.dev0.tar.gz.

File metadata

File hashes

Hashes for js_python_starter-20260430001548.dev0.tar.gz
Algorithm Hash digest
SHA256 a21bf4da5fd96ed9375f20b5c2c470814382310611382aee8b61a03d208968cc
MD5 680983e2000630b553275b396979bc26
BLAKE2b-256 7220e67d57b7f8158d34a972ef3ed202e0d5f1bb897199a7639817b7363de971

See more details on using hashes here.

Provenance

The following attestation bundles were made for js_python_starter-20260430001548.dev0.tar.gz:

Publisher: ci-cd.yml on jnstockley/python-starter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file js_python_starter-20260430001548.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for js_python_starter-20260430001548.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 4dc90b9caf2130d2c26f2777ee3ac893afa6ea01456bf7ae54c321325947be4e
MD5 3451454fa976771774beb93dc9a86f18
BLAKE2b-256 255cc0e05f21319faa91637a0fe151804636f015ba18eacf662a9f3ce2cbb384

See more details on using hashes here.

Provenance

The following attestation bundles were made for js_python_starter-20260430001548.dev0-py3-none-any.whl:

Publisher: ci-cd.yml on jnstockley/python-starter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page