78 lines (57 loc) · 1.57 KB

Publishing to PyPI

This document provides instructions for publishing the omarchy-mcp package to PyPI.

Prerequisites

Install build tools:
```
pip install build twine
```
Create a PyPI account at https://pypi.org/account/register/
Generate an API token at https://pypi.org/manage/account/token/

Building the Package

Build the distribution packages:
```
python -m build
```
This will create:
- dist/omarchy_mcp-0.1.0-py3-none-any.whl (wheel)
- dist/omarchy_mcp-0.1.0.tar.gz (source distribution)

Publishing to PyPI

Test PyPI (Recommended First)

Upload to Test PyPI:

python -m twine upload --repository testpypi dist/*

Install from Test PyPI to verify:

pip install --index-url https://test.pypi.org/simple/ omarchy-mcp

Production PyPI

Upload to PyPI:
```
python -m twine upload dist/*
```
Install from PyPI:
```
pip install omarchy-mcp
```

Versioning

To release a new version:

Update the version in pyproject.toml
Update the version in src/omarchy_mcp/__init__.py
Commit the changes
Create a git tag:
```
git tag v0.1.1
git push origin v0.1.1
```
Rebuild and publish

Verification

After publishing, verify the package:

Check the PyPI page: https://pypi.org/project/omarchy-mcp/

Install in a clean environment and test:

python -m venv test_env
source test_env/bin/activate  # On Windows: test_env\Scripts\activate
pip install omarchy-mcp
omarchy-mcp --version