Skip to content

Package Distribution for v1.0.0 #63

Description

@octo-youcef

Goal

Make Mapper easily installable and distributable through multiple package management tools.

User Outcome

A user can install Mapper via:

  • uv tool install mapper
  • pip install mapper
  • pipx install mapper
  • uv pip install mapper
  • Installation from cloned repository (pip install -e .)

Implementation Requirements

PyPI Publishing

  • Automated publishing workflow via GitHub Actions
  • Versioning strategy:
    • Stable releases: 1.0.0, 1.1.0, 1.2.0
    • Pre-releases during development: 1.1.0a1, 1.1.0b1, 1.1.0rc1
    • pip install mapper → gets latest stable only (not dev versions)
    • pip install --pre mapper → gets pre-releases
    • Development versions (e.g., 1.1.x in dev) are NOT installable until officially released
  • Package metadata - Proper setup in pyproject.toml
  • Distribution artifacts - sdist and wheel
  • Version management - Clear release process with pre-release tagging

Documentation

  • Installation instructions for each method
  • Release process documentation (when to use alpha/beta/rc tags)
  • PyPI package page with proper description and links

Testing

  • Verify each installation method works
  • Test upgrade path from older versions
  • Verify pre-release versions are gated correctly

Effort Estimate

10-14 hours (increased to account for versioning workflow)

Reference

See ROADMAP.md v1.0.0 section for detailed requirements.

Priority

HIGH - Required for production use and defines v1.0.0 milestone

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions