Skip to main content

rfcman — a BigTalk utility: fast CLI for managing RFC lifecycles

Project description

rfcman

Description

rfcman — a BigTalk utility.

A fast, elegant CLI for managing RFC lifecycles.

Incubated for BigTalk; usable for any project that needs structured proposal workflows.

Install

pip install rfcman

Requires Python 3.12+.

Quick start

rfcman init
rfcman new idea "Faster module loading"
rfcman list ideas
rfcman describe Idea-faster-module-loading
rfcman upgrade Idea-faster-module-loading
rfcman check

Lifecycle

Idea → Research → Proposed → Accepted
                           ↘ Rejected
Accepted → Superseded
  • upgrade keeps the previous document and creates the next stage with a references link (Idea-new-idea, Research-new-idea, …).
  • From Proposed, choose Accept or Reject.
  • Accepting can optionally supersede an existing accepted RFC (type-to-filter picker).
  • rfcman supersede <old> <new> does the same non-interactively.

Each document stores a UUID in frontmatter. CLI args, completions, and references use Stage-filename (e.g. Idea-typed-channels for ideas/typed-channels.md). Cross-links in related / supersedes / superseded_by store UUIDs so they survive renames and stage moves.

rfcman init writes rfcman.yml in the directory where you ran the command, recording the tree location, created date, and author (from git config). Later commands discover that file (walking up from cwd) unless you pass --path / -p. Change author in rfcman.yml to override the byline on new documents.

Command Purpose
rfcman help [CMD] Show help for rfcman or a command
rfcman init [-p PATH] Create an RFC tree (./rfcs by default)
rfcman new idea NAME Create an idea (author from rfcman.yml, else git)
rfcman list [STAGE] One-line listing
rfcman describe REF Summary + reference tree (terminal hyperlinks)
rfcman upgrade REF Advance to the next stage
rfcman supersede OLD NEW Mark accepted OLD superseded by accepted NEW
rfcman check Integrity check for links and layout

Every command also accepts help (e.g. rfcman init help, rfcman describe help).

Templates

init dumps editable body templates into rfcs/_tpls/. Frontmatter is owned by rfcman and is not dumped or overridable.

Shell completions

rfcman --install-completion bash
rfcman --install-completion zsh
rfcman --install-completion fish

Or print a script to source yourself:

rfcman --show-completion bash > completions/rfcman.bash

Pre-generated scripts also live in completions/.

After install, tab-complete:

  • commands and options
  • list stage names
  • RFC refs for describe, upgrade, and supersede (match by stage, filename stem, or title)

Development

python -m pip install -e ".[dev]"
ruff check .
ruff format .
mypy
pytest

Versioning and changelog use Commitizen (Conventional Commits):

cz bump

License

Apache-2.0

AI Disclosures

This project has significant contributions from AI.

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

rfcman-0.1.0.tar.gz (741.1 kB view details)

Uploaded Source

Built Distribution

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

rfcman-0.1.0-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

Details for the file rfcman-0.1.0.tar.gz.

File metadata

  • Download URL: rfcman-0.1.0.tar.gz
  • Upload date:
  • Size: 741.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for rfcman-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f14094936da0af5e47dede265936f1904a21e8b6dd61613918893149fd1d06cf
MD5 33ce3574fd33b9fdba96c383b357b7ba
BLAKE2b-256 3a9e6104a8a1eb89cc5066a39e9c288687c5c0c1944c2a5e693ec2002cbd7bda

See more details on using hashes here.

File details

Details for the file rfcman-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rfcman-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 25.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for rfcman-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11c76c472af6149e8b553a1cd4acbcbd6d3746e42bc6a6d8de22a6e2478fc516
MD5 63818bc6687cfe2651950e9a9a37078a
BLAKE2b-256 3cab762cc9f2c67612dfbdbcc4353152422c7837ab1333585a086526565ec41a

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