Building and Publishing to PyPI

This document provides instructions for building and publishing the vultr-dns-mcp package to PyPI.

Prerequisites

Install build tools:
```
pip install build twine
```

Set up PyPI credentials:

Create account on PyPI
Create account on TestPyPI for testing
Generate API tokens for both accounts

Configure credentials in ~/.pypirc:

[distutils]
index-servers =
    pypi
    testpypi

[pypi]
username = __token__
password = pypi-your-api-token-here

[testpypi]
repository = https://test.pypi.org/legacy/
username = __token__
password = pypi-your-test-api-token-here

Building the Package

Clean previous builds:
```
rm -rf build/ dist/ *.egg-info/
```
Build the package:
```
python -m build
```
This creates:
- dist/vultr_dns_mcp-1.0.0-py3-none-any.whl (wheel)
- dist/vultr-dns-mcp-1.0.0.tar.gz (source distribution)
Verify the build:
```
python -m twine check dist/*
```

Testing on TestPyPI

Upload to TestPyPI:

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

Test installation from TestPyPI:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple vultr-dns-mcp

Test functionality:

vultr-dns-mcp --help
python -c "from vultr_dns_mcp import VultrDNSClient; print('Import successful')"

Publishing to PyPI

Upload to PyPI:
```
python -m twine upload dist/*
```
Verify publication:
- Check the package page: https://pypi.org/project/vultr-dns-mcp/
- Test installation: pip install vultr-dns-mcp

Version Management

Update version in _version.py:
```
__version__ = "1.1.0"
```
Update version in pyproject.toml:
```
version = "1.1.0"
```
Update CHANGELOG.md with new version details
Create git tag:
```
git tag v1.1.0
git push origin v1.1.0
```

Automated Publishing (GitHub Actions)

Create .github/workflows/publish.yml:

name: Publish to PyPI

on:
  release:
    types: [published]

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.x'
    - name: Install build dependencies
      run: |
        python -m pip install --upgrade pip
        pip install build twine
    - name: Build package
      run: python -m build
    - name: Publish to PyPI
      env:
        TWINE_USERNAME: __token__
        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
      run: twine upload dist/*

Release Checklist

Update version numbers
Update CHANGELOG.md
Run tests: pytest
Check code quality: black --check src tests && isort --check src tests
Type check: mypy src
Build package: python -m build
Check package: twine check dist/*
Test on TestPyPI
Create git tag
Upload to PyPI
Verify installation works
Update documentation if needed

Package Maintenance

Dependencies

Keep dependencies updated in pyproject.toml
Test with latest versions of dependencies
Consider version constraints for stability

Documentation

Keep README.md updated with new features
Update API documentation for new methods
Add examples for new functionality

Testing

Add tests for new features
Maintain high test coverage
Test against multiple Python versions

Security

Regularly update dependencies
Monitor for security vulnerabilities
Follow security best practices

3.8 KiB Raw Blame History