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-20260505140319.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.

File details

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

File metadata

File hashes

Hashes for js_python_starter-20260505140319.dev0.tar.gz
Algorithm Hash digest
SHA256 8837d4f39da01a0596369ebec753a4ded2051c88044132da1ef9cdc871cfc801
MD5 e6f472ceaf608732e5a0faf640a1d776
BLAKE2b-256 4eb9405161ed34030d5dada7599019d902f70dc58adc6fea60bb1eb353ecaae6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for js_python_starter-20260505140319.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c0284b598d4a30d352d88ff42f6202b479dbb4bce8d658659732359393ac615
MD5 651ecb8d5d5143437621181d0d8de771
BLAKE2b-256 a7c3f19dcba46c65d7ed20cd4f283e3d4f773ff164196a646083ba3d0c86605b

See more details on using hashes here.

Provenance

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