Skip to main content

Sync local planning files to GitHub Issues.

Project description

Planning Sync Service

This repository hosts the main CLI app, planhub, that syncs local planning artifacts (plans, issues, milestones written as .md files) to GitHub Issues via API.

Goals

  • Keep planning artifacts in git and reviewable.
  • Generate/update GitHub issues and milestones from local files.
  • Make planning conversational: we can edit .md files and sync later.

Proposed Architecture

We split the system into two parts:

  1. CLI app (this repo): handles GitHub API communication and syncing.
  2. Data repo: contains the plans/, issues/, and milestones/ files.

The CLI will scaffold the data repo and then sync it on demand.

Commands

  • planhub init
    • Creates the standard folder structure in the current git repo: plans/, issues/, milestones/, and docs/.
  • planhub sync
    • Reads the .md files and creates/updates GitHub issues/milestones.

Suggested Data Repo Layout

plans/
issues/
milestones/
docs/

Next Steps

  • Finalize the file formats (see docs/).
  • Implement init and sync commands.
  • Add CI to validate the file format.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

planhub-0.0.1.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

planhub-0.0.1-py3-none-any.whl (2.5 kB view details)

Uploaded Python 3

File details

Details for the file planhub-0.0.1.tar.gz.

File metadata

  • Download URL: planhub-0.0.1.tar.gz
  • Upload date:
  • Size: 35.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for planhub-0.0.1.tar.gz
Algorithm Hash digest
SHA256 61ad360c7323775672d67a8fd1dd7f7041791f6480818b6fe554e21fd53268f9
MD5 9a7ad3efa37707e83ab5abf3c301f0bf
BLAKE2b-256 6889edc1038d2c591ebf3a9607edbbea1f5ba4a1a63b6887845470cab6c605ac

See more details on using hashes here.

File details

Details for the file planhub-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: planhub-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for planhub-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8d63bc2e36aaa4655d8f4550cbb568b8453d91b086458053ce369f7a3d299c16
MD5 3633a2acd27fddc4d60c1e03d36b8783
BLAKE2b-256 d56bc39c99faff7dd245da61d39833f0328bd28020f287c6f434a896ed04dacc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page