python-xml2rfc
Port variant py38
Summary Request For Comment authoring with XML (PY38)
Package version 3.11.1
Homepage https://tools.ietf.org/tools/xml2rfc/trac/
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants py39
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 02 NOV 2021, 23:30:32 UTC
Port created 15 AUG 2018, 15:32:35 UTC
Subpackage Descriptions
single 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 which 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). Note that the grammar for v3 is still being refined, and changes will eventually be captured in the `bis draft for 7991`_. Changes not yet captured can be seen in the xml2rfc source `v3.rng`_, or in the `documentation xml2rfc produces`_ with its --doc flag. **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. .. _IETF: https://www.ietf.org/ .. _RFCs: https://www.rfc-editor.org/ .. _RFC7749: https://tools.ietf.org/html/rfc7749 .. _RFC7991: https://tools.ietf.org/html/rfc7991 .. _bis draft for 7991: https://tools.ietf.org/html/draft-iab-rfc7991bis .. _v3.rng: https://trac.tools.ietf.org/tools/xml2rfc/trac/browser/trunk/cli/xml2rfc/data/v3.rng .. _documentation xml2rfc produces: https://xml2rfc.tools.ietf.org/xml2rfc-doc.html .. _preptool: https://tools.ietf.org/html/rfc7998 Installation ============ Installation of the python package is done as usual with 'pip install xml2rfc', using appropriate switches and/or sudo. Installation of support libraries for the PDF-formatter ------------------------------------------------------- In order to generate PDFs, xml2rfc uses the WeasyPrint module, which depends on external libaries that must be installed as native packages on your platform, separately from the xml2rfc install. First, install the Cairo, Pango, and GDK-PixBuf library files on your system. See installation instructions on the WeasyPrint Docs: https://weasyprint.readthedocs.io/en/stable/install.html (On some OS X systems with System Integrity Protection active, you may need to create a symlink from your home directory to the library installation directory (often /opt/local/lib): ln -s /opt/local/lib ~/lib in order for weasyprint to find the installed cairo and pango libraries. Whether this is needed or not depends on whether you used macports or homebrew to install cairo and pango, and the homebrew / macport version.) Next, install the pycairo and weasyprint python modules using pip. Depending on your system, you may need to use 'sudo' or install in user-specific directories, using the --user switch. On OS X in particular, you may also need to install a newer version of setuptools using --user before weasyprint can be installed. If you install with the --user switch, you may need to also set PYTHONPATH, e.g., PYTHONPATH=/Users/henrik/Library/Python/3.6/lib/python/site-packages for Python 3.6. The basic pip commands (modify as needed according to the text above) are: pip install 'pycairo>=1.18' 'weasyprint<=0.42.3' With these installed and available to xml2rfc, the --pdf switch will be enabled. For PDF output, you also need to install the Noto font set. Download the full set from https://noto-website-2.storage.googleapis.com/pkgs/Noto-unhinted.zip, and install as appropriate for your platform. 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. Changelog =========
Configuration Switches (platform-specific settings discarded)
PY38 ON Build using Python 3.8 PY39 OFF Build using Python 3.9
Package Dependencies by Type
Build (only) python-setuptools:single:py38
autoselect-python:single:standard
Build and Runtime python-appdirs:single:py38
python-ConfigArgParse:single:py38
python-google-i18n-address:single:py38
python-html5lib:single:py38
python-intervaltree:single:py38
python-Jinja2:single:py38
python-kitchen:single:py38
python-lxml:single:py38
python-pycountry:single:py38
python-pyflakes:single:py38
python-PyYAML:single:py38
python-requests:single:py38
python-setuptools:single:py38
python-six:single:py38
python38:single:standard
Download groups
main mirror://PYPI/x/xml2rfc
Distribution File Information
575129bf94c9e3e1a7874f7a8de4083741ce0a3f86a027505bf3e8979881ac5c 3165013 xml2rfc-3.11.1.tar.gz
Ports that require python-xml2rfc:py38
memcached:standard Distributed memory object caching system