Skip to content

tool that creates sequence diagrams from annotated RFCs

Notifications You must be signed in to change notification settings

abe-winter/rfckit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rfckit

Thing for generating fancy sequence diagrams from annotated RFCs / standards doc.

It's a:

  • file format for sequence diagrams annotated with standards info
  • html generator for sequence diagrams

The goal is to be able to read an RFC in the context of a sequence diagram.

The reach goal is to develop markup formats that can exist within RFCs so these diagrams are generated automatically from written specs.

Example

You can view the generated output for the oauth 2.0 authorization flow (based on the oauth sample spec in this repo).

Who should use this

If you want to generate highly annotated sequence diagrams for your own projects, or if you're publishing or writing about an RFC, this may be for you.

Docs

There are none -- file an issue if you want to use this and need help. But you can get started looking at oauth.yml and spec.py in this codebase.

To run the program, do something like:

direnv allow
pip install -r requirements.txt
# main.py defaults to samples/oauth.yml
./main.py > oauth.htm
xdg-open oauth.htm # (or `open` on a mac)

About

tool that creates sequence diagrams from annotated RFCs

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published