Skip to content

PUBLISH_CHECKLIST.md

Latest commit

 

History

History
141 lines (112 loc) · 3.65 KB

PUBLISH_CHECKLIST.md

File metadata and controls

141 lines (112 loc) · 3.65 KB

PyPI Publishing Checklist ✅

All steps completed! Here's what's ready:

✅ Project Files

  • README.md - Comprehensive documentation with features, installation, and usage examples
  • LICENSE - MIT License
  • pyproject.toml - Build system configuration
  • setup.cfg - Package metadata with PyPI classifiers
  • .gitignore - Standard Python/IDE ignores
  • .github/workflows/publish-pypi.yml - Automated GitHub Actions workflow
  • PUBLISHING.md - Step-by-step publishing guide

✅ Package Configuration

  • Package name: pythonprojectmanager
  • Console script entry point: ppm
  • Version: 0.1.0
  • Python requirement: >=3.10
  • Package data: templates.json included

✅ Build Verification

  • Wheel builds successfully: pythonprojectmanager-0.1.0-py3-none-any.whl (14 KB)
  • All modules included in build
  • License file packaged

📋 Next Steps to Publish

1. Create GitHub Repository (5 minutes)

# Your GitHub setup:
# 1. Go to https://github.com/new
# 2. Create "PythonProjectManager" repo
# 3. Copy the remote URL

2. Push Code to GitHub (2 minutes)

cd "C:\Users\kurok\Desktop\pythonFiles\PythonProjectManager"

# Update git config with YOUR details
git config user.email "your.email@gmail.com"
git config user.name "Your Name"

# Add remote (replace YOUR_USERNAME)
git remote add origin https://github.com/YOUR_USERNAME/PythonProjectManager.git

# Push to GitHub
git add .
git commit -m "Initial commit: Python virtual environment manager"
git branch -M main
git push -u origin main

3. Create PyPI Account & API Token (5 minutes)

1. Register at https://pypi.org/account/register/
2. Verify email
3. Create API token at https://pypi.org/manage/account/tokens/
   - Scope: "Entire repository"
   - Copy the token (starts with "pypi-")

4. Add PyPI Token to GitHub Secrets (3 minutes)

1. Go to GitHub repo → Settings → Secrets and variables → Actions
2. Click "New repository secret"
3. Name: PYPI_API_TOKEN
4. Value: Paste your PyPI token
5. Click "Add secret"

5. Create Release Tag & Publish (1 minute)

# From your local repo
cd "C:\Users\kurok\Desktop\pythonFiles\PythonProjectManager"

# Create tag
git tag v0.1.0

# Push tag (triggers automatic publish)
git push origin v0.1.0

6. Verify Publication (2 minutes)

1. Check GitHub Actions tab to see workflow running
2. Once complete, check: https://pypi.org/project/pythonprojectmanager/
3. Users can now install: pip install pythonprojectmanager

📊 What Gets Published

Users will be able to:

pip install pythonprojectmanager
ppm --help
ppm interpreter detect
ppm create-venv <interpreter> <venv_dir>
ppm template list

🔄 Future Releases

For version 0.2.0:

# 1. Update version in setup.cfg
#    [metadata]
#    version = 0.2.0

# 2. Commit and tag
git add setup.cfg
git commit -m "Bump version to 0.2.0"
git tag v0.2.0
git push origin main
git push origin v0.2.0

# Automatically publishes to PyPI!

📝 Optional: Update Package Metadata

Before first release, customize in setup.cfg:

[metadata]
url = https://github.com/YOUR_USERNAME/PythonProjectManager
author = Your Name
author_email = your.email@example.com

🔗 Useful Links

Estimated total time to publish: ~15 minutes

You're all set! Follow the steps above to get your CLI on PyPI. 🎉