Skip to main content

Automating IETF comment handling

Project description

The IETF Comments Processor

Python version requirement Package version

Handling comments from the IESG, multiple directorate reviews, and in AUTH48 can be burdensome for document authors, because of the sheer number of comments, and because they come in an unstructured format that has to be manually processed.

This package installs two commands:

  • ietf-comments processes comments from the IESG and directorates in a markdown-based format.
  • rfced-comments processes comments from the RFC Editor in RFC XML files.

Both can be used to create GitHub issues for the comments they find. When used properly, they can help automate formerly tiresome tasks.

For IESG and directorate comments, this tool uses the IETF Comment Markdown format, which is a semi-structured format that is similar to that which ADs and directorates use now. Ideally, they will create comments in that format for easy processing, but even when they don't, most comments can easily be transformed into it for processing.

Installation

To install ietf-comments, you'll need Python 3.10 or greater. Then, run:

pip3 install ietf-comments

Note that if your pip is using another version of Python, it will silently install an outdated version of the package. To assure that Python 3.10 is being used, you may need to use something like:

python3.10 -m pip install ietf-comments

Use

Processing AD and Directorate Comments

To validate a AD or Directorate review in the IETF Comment Markdown format and see the identified issues, run:

ietf-comments filename

To create a GitHub issue for each issue, set GITHUB_ACCESS_TOKEN in your environment to a GitHub Personal Access Token and run:

ietf-comments -g owner/repo filename

... where owner/repo is the repo owner and name, separated by a slash.

If you'd like these issues to have a specific label, run:

ietf-comments -g owner/repo filename -l labelname

If you'd like discuss, comment, and nit labels added as appropriate, along with a review label, pass -a:

ietf-comments -g owner/repo filename -a

Processing RFC Editor Comments

To validate RFC Editor comments in a local RFC XML file and see the identified issues, run:

rfced-comments filename

Alternatively, if you're in AUTH48 and the RFC Editor has published a draft of your RFC-to-be, you can just run

rfced-comments NNNN

where NNNN is the RFC number.

To create a GitHub issue for each issue, set GITHUB_ACCESS_TOKEN in your environment to a GitHub Personal Access Token and run:

rfced-comments -g owner/repo NNNN_or_filename

... where owner/repo is the repo owner and name, separated by a slash.

If you'd like these issues to have a specific label, run:

rfced-comments -g owner/repo NNNN_or_filename -l labelname

Special Features

The following features are currently supported (more soon!):

  • When recognised, internal section references (e.g., Section 2.4) are auto-linked in created issues.
  • Likewise, references to external RFCs (e.g., Section 5.3 of [RFC1234]) will also be auto-linked in created issues when recognised.
  • Text in blockquotes (preceded by >) in comments will be checked for presence in the document; if they aren't found, a warning will be raised.

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

ietf_comments-0.1.5.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

ietf_comments-0.1.5-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file ietf_comments-0.1.5.tar.gz.

File metadata

  • Download URL: ietf_comments-0.1.5.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for ietf_comments-0.1.5.tar.gz
Algorithm Hash digest
SHA256 7e87a4f65c5137fe2023faf1d1aead068bb862a28e998d77d6d3defca6193fb6
MD5 34ee001a8eb181a0a95595af476056a3
BLAKE2b-256 b60bbaba357c608b2a58658b5bae5faec71cfa3caa0b53fd9f7cc10ccf0cc2eb

See more details on using hashes here.

Provenance

File details

Details for the file ietf_comments-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: ietf_comments-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for ietf_comments-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 751c53dc88140218404348bb8206a5ecee8f97df16b99d349bdcbd44ae1ea8dc
MD5 0aa4f34599958eb9ce45068df2e29ec9
BLAKE2b-256 8d9a533fd74a91af7635b62896db7e130b10da9e59df921f86cc42e9df9d21c1

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