xml2rfc generates RFCs and IETF drafts from document source in XML according to the IETF xml2rfc v2 and v3 vocabularies.

Navigation

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: BSD-3-Clause
    SPDX License Expression
  • Author: IETF Tools
  • Tags ietf , rfc , id , internet-draft , xml , xml2rfc , xmlrfc
  • Requires: Python >=3.9
  • Provides-Extra: pdf , tests
Classifiers
Report project as malware

Project description

XML2RFC

Release License PyPI - Version PyPI - Status PyPI - Format

Generate RFCs and IETF drafts from document source in XML according to the IETF xml2rfc v2 and v3 vocabularies

Introduction

The IETF uses a specific format for the standards and other documents it publishes as RFCs, and for the draft documents which are produced when developing documents for publications. There exists a number of different tools to facilitate the formatting of drafts and RFCs according to the existing rules, and this tool, xml2rfc, is one of them. It takes as input an xml file that contains the text and meta-information about author names etc., and transforms it into suitably formatted output. The input xml file should follow the grammars in RFC7749 (for v2 documents) or RFC7991 (for v3 documents).

RFCXML vocabulary reference is available at authors.ietf.org.

xml2rfc provides a variety of output formats. See the command line help for a full list of formats. It also provides conversion from v2 to v3, and can run the preptool on its input.

Installation

xml2rfc is available as Python package. You can install it with following command:

pip install xml2rfc

If you're using pipx, you can install xml2rfc with the following command:

pipx install xml2rfc

xml2rfc also provides pdf extra package to install required packages required for PDF file generation. See next section about additional requirements for PDF generation.

To install xml2rfc with PDF generation support run:

pip install "xml2rfc[pdf]"

To install pdf extra with pipx run:

pipx install "xml2rfc[pdf]"

Installation of support libraries for the PDF-formatter

In order to generate PDFs, xml2rfc uses the WeasyPrint module, which depends on external libraries that must be installed as native packages on your platform, separately from the xml2rfc install.

  1. First, install the Pango, and other required libraries on your system. See installation instructions on the WeasyPrint Docs.

  2. Next, install WeasyPrint python modules using pip.

pip install "xml2rfc[pdf]"
  1. Finally, install the required fonts:
  • Download latest fonts from xml2rfc-fonts.
  • In the Assets section, download either the tar.gz or the zip archive.
  • Extract the contents of the downloaded xml2rfc-fonts archive.
  • Install the fonts found in the noto and roboto_mono directories to your operating system.

With these installed and available to xml2rfc, the --pdf switch will be enabled.

Updating xml2rfc

To update xml2rfc, run the following command:

pip install --upgrade xml2rfc

If you are using pipx, you can update it with:

pipx upgrade xml2rfc

Usage

xml2rfc accepts a single XML document as input and outputs to one or more conversion formats.

Basic Usage

xml2rfc SOURCE [options] FORMATS...

Run xml2rfc --help for a full listing of command-line options.

Getting Started

This project is following the standard Git Feature Workflow development model. Learn about all the various steps of the development workflow, from creating a fork to submitting a pull request, in the Contributing guide.

Make sure to read the Styleguides section to ensure a cohesive code format across the project.

You can submit bug reports, enhancements and new feature requests in the discussions area. Accepted tickets will be converted to issues.

Git Cloning Tips

As outlined in the Contributing guide, you will first want to create a fork of the xml2rfc project in your personal GitHub account before cloning it.

For example (replace USERNAME with your GitHub username):

git clone https://github.com/USERNAME/xml2rfc.git

Docker Dev Environment

Run ./run.sh command to build and start a docker development environment. The initial build may take time because it downloads all required fonts as well.

./run.sh

Project details

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: BSD-3-Clause
    SPDX License Expression
  • Author: IETF Tools
  • Tags ietf , rfc , id , internet-draft , xml , xml2rfc , xmlrfc
  • Requires: Python >=3.9
  • Provides-Extra: pdf , tests
Classifiers

Release history Release notifications | RSS feed

This version

3.30.0

3.29.0

3.28.1

3.28.0

3.27.0

3.26.0

3.25.0

3.24.0

3.23.2

3.23.1

3.23.0

3.22.0

3.21.0

3.20.1

3.20.0

3.19.4

3.19.3

3.19.2

3.19.1

3.19.0

3.18.2

3.18.1

3.18.0

3.17.5

3.17.4

3.17.3

3.17.2

3.17.1

3.17.0

3.16.0

3.15.3

3.15.2

3.15.1

3.15.0

3.14.2

3.14.1

3.14.0

3.13.1

3.13.0

3.12.10

3.12.9 yanked

Reason this release was yanked:

invalid signature

3.12.8

3.12.7

3.12.6

3.12.5

3.12.4

3.12.3

3.12.2

3.12.1

3.12.0

3.11.1

3.11.0

3.10.0

3.9.1

3.9.0

3.8.0

3.7.0

3.6.0

3.5.0

3.4.0

3.3.0

3.2.1

3.2.0

3.1.1

3.1.0

3.0.0

2.47.0

2.46.0

2.45.3

2.45.2

2.45.1

2.45.0

2.44.0

2.43.0

2.42.0

2.41.0

2.40.1

2.40.0

2.39.0

2.38.1

2.38.0

2.37.3

2.37.2

2.37.1

2.37.0

2.36.0

2.35.0

2.34.0

2.33.0

2.32.0

2.31.0

2.30.0

2.29.1

2.29.0

2.28.0

2.27.1

2.27.0

2.26.0

2.25.0

2.24.0

2.23.1

2.23.0

2.22.3

2.22.2

2.22.1

2.22.0

2.21.1

2.21.0

2.20.1

2.20.0

2.19.1

2.19.0

2.18.0

2.17.2

2.17.1

2.17.0

2.16.3

2.16.2

2.16.1

2.16.0

2.15.5

2.15.4

2.15.3

2.15.2

2.15.1

2.15.0

2.14.1

2.14.0

2.13.1

2.13.0

2.12.3

2.12.2

2.12.1

2.12.0

2.11.1

2.11.0

2.10.3

2.10.2

2.10.1

2.10.0

2.9.9

2.9.8

2.9.7

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.0

2.6.2

2.6.1

2.6.0

2.5.3.dev0 pre-release

2.5.2

2.5.1

2.5.0

2.4.12

2.4.11

2.4.10

2.4.10.dev0 pre-release

2.4.9

2.4.8

2.4.7

2.4.6

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.11.3

2.3.11.2

2.3.11.1

2.3.11

2.3.10

2.3.9

2.3.8

2.3.7

2.3.6

2.3.5

2.3.4

2.3.3

2.3.2

2.3.1

2.3.0

2.2.7

2.2.5

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xml2rfc-3.30.0.tar.gz (420.6 kB view details)

Uploaded Source

Built Distribution

xml2rfc-3.30.0-py3-none-any.whl (375.8 kB view details)

Uploaded Python 3

File details

Details for the file xml2rfc-3.30.0.tar.gz.

File metadata

  • Download URL: xml2rfc-3.30.0.tar.gz
  • Upload date:
  • Size: 420.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xml2rfc-3.30.0.tar.gz
Algorithm Hash digest
SHA256 b977b26edd5d930020966fa4692fc7fcdcb4f7401a8429981d4cbc0cc4bbba25
MD5 9c0c91bb1fbd7b8401a80674baaa077a
BLAKE2b-256 7bdc4207f1b808dc974b199d9e491601401baf1e32a81cafc2a209dcc75062fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for xml2rfc-3.30.0.tar.gz:

Publisher: pypi-publish.yml on ietf-tools/xml2rfc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xml2rfc-3.30.0-py3-none-any.whl.

File metadata

  • Download URL: xml2rfc-3.30.0-py3-none-any.whl
  • Upload date:
  • Size: 375.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xml2rfc-3.30.0-py3-none-any.whl
Algorithm Hash digest
SHA256 49d128d69f372655d1f36f21aedd4a1defb6c5fcbf28b782f1ba5d46353b455f
MD5 527ac4f950b78bf6dec222ac21a8ef9a
BLAKE2b-256 c65388614e571682a41000008395ed0b414a23cda1af8869663af66b96338a7e

See more details on using hashes here.

Provenance

The following attestation bundles were made for xml2rfc-3.30.0-py3-none-any.whl:

Publisher: pypi-publish.yml on ietf-tools/xml2rfc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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