Skip to content

Prepare and publish the first public PyPI release #32

Description

@antonisloukis

Problem

RunbookProof currently installs from source. This creates additional setup steps and makes it harder for users to test the tool in local environments and CI pipelines.

Proposed Solution

Prepare and publish the first public RunbookProof package release to PyPI.

The release process should be reproducible, documented, and use trusted publishing rather than long-lived API credentials where possible.

Example

After publication, users should be able to install or execute RunbookProof with commands such as:

uvx runbookproof scan README.md

or:

pip install runbookproof
runbookproof scan docs/

Acceptance Criteria

  • Package metadata is reviewed and validated.
  • The package builds successfully as both a wheel and source distribution.
  • Built distributions pass package validation.
  • Installation is tested in a clean environment.
  • The CLI entry point works after installation.
  • A release workflow is configured.
  • PyPI trusted publishing is used where supported.
  • The release process is documented.
  • Installation instructions in the README are updated.
  • The changelog contains the release notes.
  • Version 0.1.0 is tagged and published.

Alternatives Considered

Continue source-only installation during pre-alpha development. This reduces release work but makes real-world testing and adoption more difficult.

Feature Area

  • Detection rules
  • CLI
  • Markdown parsing
  • JSON output
  • SARIF output
  • GitHub integration
  • Configuration
  • Documentation
  • Performance
  • Other

Contribution

  • I would be interested in implementing this feature.
  • I would need guidance before implementing it.

Additional Context

The release should only occur after the package name, metadata, supported Python versions, license information, and release workflow have been verified.

Checklist

  • I searched existing issues for similar requests.
  • This request is related to RunbookProof.
  • I have not included secrets or private infrastructure information.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions