Skip to main content

Markdown extension for interactive regulations

Project description

Regdown

Build StatusCoverage Status

Regdown is a Python-Markdown extension for interactive regulation text.

Dependencies

Installation

First, install Regdown:

pip install regdown

Then you can either:

  • Specify Regdown as an extension in calls to markdown:

    import markdown
    from regdown import RegulationsExtension
    
    markdown.markdown(text, extensions=[RegulationsExtension()],)
    
  • Use convenience regdown function to render Markdown with the RegulationsExtension:

    from regdown import regdown
    
    regdown(text)
    

Documentation

Regdown adds three major features to Markdown to support making federal regulations easier to navigate and read.

Labeled Paragraphs

{label} Paragraph text

Each paragraph can have a defined label, using {label} syntax at the start of the paragraph. This is translated into an id attribute on the resulting HTML paragraph element. If no label is given, the contents of the paragraph are hashed to generate a unique id for that paragraph. This makes any paragraph in the text directly linkable.

Pseudo Forms

  • Form field: __
  • __Form Field
  • inline__fields__

Example print forms, where the \_\_ indicate a space for hand-written input. Can be any number of underscores between 2 and 50.

Section symbols

§ 1024.5(d) §1024.5(d)

Section symbols will always have a non-breaking space ( ) inserted between them and whatever follows to avoid hanging a symbol at the end of a line.

Block references

see(label)

Insert the contents of labeled paragraphs in other Regdown documents inline into the current document.

References can be placed before or after paragraphs. These references are to labeled paragraphs in other Markdown documents. When a contents_resolver callback and url_resolver callback are provided, the text of those other paragraphs can be looked up and inserted inline into the document making the reference. If render_block_reference callback is provided, custom rendering of the referenced text to HTML can be performed.

Callbacks:

  • contents_resolver(label): resolve the paragraph label and return the Markdown contents of that paragraph if the paragraph exists.
  • url_resolver(label): resolve the paragraph label and return a URL to that paragraph if the paragraph exists.
  • render_block_reference(contents, url=None): render the contents of a block reference to HTML. The url to the reference may be give as a keyword argument if url_resolver is provided.
from regdown import regdown

def my_contents_resolver(label):
    # Lookup the document that contains the given label …
    return corresponding_markdown_text

def my_block_renderer(block_markdown_contents, url=None):
    # Render the block to HTML
    return block_html

regdown(
    text,
    contents_resolver=my_contents_resolver,
    render_block_reference=my_block_renderer
)

Getting help

Please add issues to the issue tracker.

Getting involved

General instructions on how to contribute can be found in CONTRIBUTING.

Licensing

  1. TERMS
  2. LICENSE
  3. CFPB Source Code Policy

Credits and references

regdown was forked from Wagtail-Flags, which was itself forked from consumerfinance.gov.

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

regdown-1.0.6.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

regdown-1.0.6-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file regdown-1.0.6.tar.gz.

File metadata

  • Download URL: regdown-1.0.6.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for regdown-1.0.6.tar.gz
Algorithm Hash digest
SHA256 f3ee4e65a58f59938e48747fe38b4ad2459a0cef4abe3afd6bb027b70f6d3691
MD5 9b059d24b9edb357b6dbc2096c72f4e9
BLAKE2b-256 688e6b3ead798495e99eea9e8ba6262059fdc97ae30f7073f1d65e826a0257ab

See more details on using hashes here.

Provenance

File details

Details for the file regdown-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: regdown-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for regdown-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 9e58b469db1dfa5d112718b32fe8754dd1b12e4f191fb09888b1cf268ebe0b21
MD5 94ca05ed8e29b4d5c228b1019e3721e4
BLAKE2b-256 48ba661349035452a5365cc4fff13ba442178043b64172802429e0e64bd874ca

See more details on using hashes here.

Provenance

Supported by

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