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-20260413154218.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-20260413154218.dev0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for js_python_starter-20260413154218.dev0.tar.gz
Algorithm Hash digest
SHA256 774327bd3570182c4ade5b1c6b7781063f7ebe98962dadfe3b656c81170c81f5
MD5 d0a68d846a5790b6f3a829de6fda9770
BLAKE2b-256 047b3dc62d4aa213917c827134d2f4f3839a91eb67a7f73a8e5b0172ec23f255

See more details on using hashes here.

Provenance

The following attestation bundles were made for js_python_starter-20260413154218.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-20260413154218.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for js_python_starter-20260413154218.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 4ca19912d1b0bfc710946bd5c8e9e8157341f667db279fc98d55c15c38e71cc5
MD5 65c6280012e5435d5d58774c01322a77
BLAKE2b-256 1d001b18dc607f8d34d3d1d18a6532e0eca7510fe31ad91d2fc957059cfa88a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for js_python_starter-20260413154218.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