Skip to main content

template python project with necessary configurations

Project description

pyproject-tmpl

features

  1. pytest
  2. pre-commit
  3. darker for code format
  4. ruff for lint
  5. commitlint for commit message format
  6. typer for cli
  7. sqlmodel for database ORM
  8. alembic for database migration

introduction

before development, must run ./scripts/setup

unit test

uv run -m pytest

run cli

uv run main.py --help

release sdk

  1. cp .pypirc.example .pypirc
  2. replace your token in .pypirc
  3. git tag vx.y.z
  4. ./scripts/publish

build executable file

./scripts/build

Project details


Download files

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

Source Distribution

pyproject_tmpl-0.1.1.dev9.tar.gz (90.7 kB view details)

Uploaded Source

Built Distribution

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

pyproject_tmpl-0.1.1.dev9-py3-none-any.whl (2.3 kB view details)

Uploaded Python 3

File details

Details for the file pyproject_tmpl-0.1.1.dev9.tar.gz.

File metadata

  • Download URL: pyproject_tmpl-0.1.1.dev9.tar.gz
  • Upload date:
  • Size: 90.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for pyproject_tmpl-0.1.1.dev9.tar.gz
Algorithm Hash digest
SHA256 6b4acc9884b0123e79552be0f5199f2e3a358d34f299774a86b8f08087fe21da
MD5 853a9fee5ba207c23b2e74fae5e6cc29
BLAKE2b-256 d5c84bd98bb2bcaf020c9998b1af938d8ea7387aeb539024bd185e20d8a5bf27

See more details on using hashes here.

File details

Details for the file pyproject_tmpl-0.1.1.dev9-py3-none-any.whl.

File metadata

File hashes

Hashes for pyproject_tmpl-0.1.1.dev9-py3-none-any.whl
Algorithm Hash digest
SHA256 a2b36c13d4f46c2ab71da6f9dd2fc7d5c925753f1bfbd7cbb51c3f4edd7b5ed9
MD5 bddf9951f463287c7b1b900614ee17ef
BLAKE2b-256 16363b8216024990a120351ec14a59792d457c9cf3e806532e014fa1ed9cc692

See more details on using hashes here.

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