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.6 or greater. Then, run:

pip3 install ietf-comments

Note that to use rfced-comments, you'll need Python 3.10 or greater. 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.2.3.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

ietf_comments-0.2.3-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ietf_comments-0.2.3.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for ietf_comments-0.2.3.tar.gz
Algorithm Hash digest
SHA256 35bf86b99af75837b1ff206eedd5d00e953b3607e064c9ea21ef1e04e16edc12
MD5 9a16f60adf4e6f1d8a940de2b1200fdd
BLAKE2b-256 5a5cba8964bb75ec9c0df81c9281862335478bc915a9964cbb4e73abfd51d669

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for ietf_comments-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aefd174e34ad494e40cf65da9f1473ac894255d67fa7d049d39846da0534dccf
MD5 e539c5fba3a0e63bf38890f6c3a9aa34
BLAKE2b-256 0f5923ee9333b732047be5aa451180dc20507fc728827681cf427109690f3c64

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