Skip to main content

A simple example Python package

Project description

Example Package

A simple example Python package for demonstrating PyPI publishing with GitHub Actions.

Installation

pip install test-pypi-qu4rkn3t-2026

Usage

from example_package import greet

# Basic usage
print(greet())  # Output: Hello, World!

# Custom greeting
print(greet("Python"))  # Output: Hello, Python!

Development

Local Installation

# Clone the repository
git clone https://github.com/yourusername/test-pypi-qu4rkn3t.git
cd test-pypi-qu4rkn3t

# Install in editable mode
pip install -e .

Building the Package

pip install build
python -m build

Publishing to PyPI

This package uses GitHub Actions to automatically publish to PyPI when a new release is created.

Setup Instructions

  1. Create a PyPI account at https://pypi.org
  2. Generate an API token at https://pypi.org/manage/account/token/
  3. Add the token as a GitHub secret named PYPI_API_TOKEN:
    • Go to your repository Settings → Secrets and variables → Actions
    • Click "New repository secret"
    • Name: PYPI_API_TOKEN
    • Value: Your PyPI API token (including the pypi- prefix)

Publishing a New Version

  1. Update the version in pyproject.toml and src/example_package/__init__.py
  2. Commit and push your changes
  3. Create a new release on GitHub:
    • Go to Releases → Draft a new release
    • Create a new tag (e.g., v0.1.0)
    • Add release notes
    • Publish the release
  4. GitHub Actions will automatically build and publish to PyPI

License

MIT

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

test_pypi_qu4rkn3t_2026-0.1.0.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

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

test_pypi_qu4rkn3t_2026-0.1.0-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file test_pypi_qu4rkn3t_2026-0.1.0.tar.gz.

File metadata

  • Download URL: test_pypi_qu4rkn3t_2026-0.1.0.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for test_pypi_qu4rkn3t_2026-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a35e54fee034cd7a9d7371cde5eebc5c36ca899dce9c7491de816f55fd143ca8
MD5 ac898c54ebd10be20c26eb3309fee7d7
BLAKE2b-256 8a0194ba719389301bae035643b4503d2c7d919bcd22f06fd6a6656742a3d28b

See more details on using hashes here.

File details

Details for the file test_pypi_qu4rkn3t_2026-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for test_pypi_qu4rkn3t_2026-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f70a73dc4422ffbab38b7b0535e68e58a8747544bbbd100a5e41cb44361b466
MD5 23bbce41d9f067d14fd72922b6b462a8
BLAKE2b-256 eba5c84bebd653110696aef7b0732c7cb1516c9f24323eaa0297d26b210e6d17

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