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-20260707130600.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-20260707130600.dev0.tar.gz.

File metadata

File hashes

Hashes for js_python_starter-20260707130600.dev0.tar.gz
Algorithm Hash digest
SHA256 d8504f76a226974c5b44015b49b3b3dc6e3dedb3c4e34aa24b94ca42008e5b1e
MD5 6babc9455a3a1464fefc0b7cdc421072
BLAKE2b-256 0e216603b44d4f02ab72cbf9b0280f414a6bdd3f4acdbe4760033804fd8c6ed5

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for js_python_starter-20260707130600.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 440b694d7e5dc528a77ee4cb50b433dea1ad0c4ae0cfbcf13b9b701cd3eb0e89
MD5 4934e92100af6fc77b534f3fb994ed51
BLAKE2b-256 b834e1d30a6f7dbe74e5b24801150e0a3c73f502dd6e2fae82753ad0bbcfc45d

See more details on using hashes here.

Provenance

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