Skip to content

PYPI_RELEASE.md

Latest commit

 

History

History
100 lines (69 loc) · 2.11 KB

PYPI_RELEASE.md

File metadata and controls

100 lines (69 loc) · 2.11 KB
Raw

Publishing Streamix Queue to PyPI

Your package is now pip-ready and built successfully! Follow these steps to publish it to PyPI.

Prerequisites

  1. Create a PyPI account at https://pypi.org/account/register/
  2. Generate an API token at https://pypi.org/manage/account/
  3. Install twine (PyPI upload tool)

Upload Steps

1. Install twine (if not already installed)

pip install twine

2. Build the package

cd /home/moundher/Desktop/Streamix
python -m build --sdist --wheel

This creates:

  • dist/streamix_queue-0.1.0-py3-none-any.whl (wheel)
  • dist/streamix_queue-0.1.0.tar.gz (source)

3. Verify package with twine

twine check dist/*

4. Upload to PyPI (Test)

First test on TestPyPI:

twine upload --repository testpypi dist/* --username __token__ --password pypi-YOUR_TEST_TOKEN

Then test installation:

pip install --index-url https://test.pypi.org/simple/ streamix-queue

5. Upload to PyPI (Production)

Once verified, upload to the real PyPI:

twine upload dist/* --username __token__ --password pypi-YOUR_PROD_TOKEN

Or use interactive mode (will prompt for token):

twine upload dist/*

6. Verify Installation

pip install streamix-queue
python -c "from streamix_queue import publish, consume; print('Success!')"

Package Contents

  • ✅ Properly structured - src/streamix_queue/ layout
  • ✅ pyproject.toml - Modern Python packaging config
  • ✅ setup.py - Compatibility layer
  • ✅ LICENSE - MIT license included
  • ✅ README.md - PyPI description
  • ✅ MANIFEST.in - File inclusion rules
  • ✅ Built successfully - Both wheel and sdist formats
  • ✅ Imports work - Tested and verified

Versioning

Update the version in pyproject.toml for future releases:

version = "0.2.0"

Then rebuild and upload with twine upload dist/* --skip-existing

Metadata

The package includes:

  • Name: streamix-queue
  • Import name: streamix_queue
  • Python: 3.10+
  • Dependencies: redis>=5.0.0
  • License: MIT
  • Keywords: redis, streams, event, messaging, queue, async