bucket_34/python-xml2rfc

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-xml2rfc
   4 VERSION=                3.18.2
   5 KEYWORDS=               python
   6 VARIANTS=               v11 v12
   7 SDESC[v11]=             Request For Comment authoring with XML (3.11)
   8 SDESC[v12]=             Request For Comment authoring with XML (3.12)
   9 HOMEPAGE=               https://github.com/ietf-tools/xml2rfc
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPI/x/xml2rfc
  14 DISTFILE[1]=            xml2rfc-3.18.2.tar.gz:main
  15 DF_INDEX=               1
  16 SPKGS[v11]=             single
  17 SPKGS[v12]=             single
  18
  19 OPTIONS_AVAILABLE=      PY311 PY312
  20 OPTIONS_STANDARD=       none
  21 VOPTS[v11]=             PY311=ON PY312=OFF
  22 VOPTS[v12]=             PY311=OFF PY312=ON
  23
  24 DISTNAME=               xml2rfc-3.18.2
  25
  26 GENERATED=              yes
  27
  28 [PY311].BUILDRUN_DEPENDS_ON=            python-platformdirs:single:v11
  29                                         python-ConfigArgParse:single:v11
  30                                         python-google-i18n-address:single:v11
  31                                         python-intervaltree:single:v11
  32                                         python-Jinja2:single:v11
  33                                         python-lxml:single:v11
  34                                         python-pycountry:single:v11
  35                                         python-PyYAML:single:v11
  36                                         python-requests:single:v11
  37                                         python-setuptools:single:v11
  38                                         python-six:single:v11
  39                                         python-wcwidth:single:v11
  40 [PY311].USES_ON=                        python:v11,sutools
  41
  42 [PY312].BUILDRUN_DEPENDS_ON=            python-platformdirs:single:v12
  43                                         python-ConfigArgParse:single:v12
  44                                         python-google-i18n-address:single:v12
  45                                         python-intervaltree:single:v12
  46                                         python-Jinja2:single:v12
  47                                         python-lxml:single:v12
  48                                         python-pycountry:single:v12
  49                                         python-PyYAML:single:v12
  50                                         python-requests:single:v12
  51                                         python-setuptools:single:v12
  52                                         python-six:single:v12
  53                                         python-wcwidth:single:v12
  54 [PY312].USES_ON=                        python:v12,sutools
  55
  56 [FILE:3510:descriptions/desc.single]
  57 <div align="center">
  58
  59 [image]
  60
  61 [Release]
  62 [License]
  63 [![PyPI - Version]](https://pypi.org/project/xml2rfc/)
  64 [![PyPI - Status]](https://pypi.org/project/xml2rfc/)
  65 [![PyPI - Format]](https://pypi.org/project/xml2rfc/)
  66
  67 ##### Generate RFCs and IETF drafts from document source in XML according
  68 to the IETF xml2rfc v2 and v3 vocabularies
  69
  70 </div>
  71
  72 - [Changelog]
  73 - [Installation]
  74 - [Usage]
  75 - [Contributing]
  76 - [Getting Started]
  77     - [Git Cloning Tips]
  78     - [Docker Dev Environment]
  79 - [Release Procedure]
  80
  81 ---
  82
  83 ### Introduction
  84
  85 The [IETF] uses a specific format for the standards and other documents it
  86 publishes as [RFCs], and for the draft documents which are produced when
  87 developing documents for publications. There exists a number of different
  88 tools to facilitate the formatting of drafts and RFCs according to the
  89 existing rules, and this tool, **xml2rfc**, is one of them. It takes as
  90 input an xml file that contains the text and meta-information about author
  91 names etc., and transforms it into suitably formatted output. The input xml
  92 file should follow the grammars in [RFC7749] *(for v2 documents)* or
  93 [RFC7991] *(for v3 documents)*. Note that the grammar for v3 is still being
  94 refined, and changes will eventually be captured in the [bis draft for
  95 7991]. Changes not yet captured can be seen in the xml2rfc source [v3.rng],
  96 or in the [documentation xml2rfc produces] with its `--doc` flag.
  97
  98 **xml2rfc** provides a variety of output formats. See the command line help
  99 for a full list of formats. It also provides conversion from v2 to v3, and
 100 can run the [preptool] on its input.
 101
 102 ### Installation
 103
 104 Installation of the python package is done as usual with `pip install
 105 xml2rfc`, using appropriate switches.
 106
 107 #### Installation of support libraries for the PDF-formatter
 108
 109 In order to generate PDFs, **xml2rfc** uses the [WeasyPrint] module, which
 110 depends on external libraries that must be installed as native packages on
 111 your platform, separately from the **xml2rfc** install.
 112
 113 1. First, install the **Pango**, and other required libraries on your
 114 system.  See installation instructions on the [WeasyPrint Docs].
 115
 116 2. Next, install WeasyPrint python modules using pip.
 117
 118 ```sh
 119 pip install 'weasyprint==55.0'
 120 ```
 121 3. Finally, install the full **Noto Font** and **Roboto Mono** packages:
 122   * Download the full font file from:
 123     https://noto-website-2.storage.googleapis.com/pkgs/Noto-unhinted.zip
 124   * Follow the installation instructions at
 125     https://www.google.com/get/noto/help/install/
 126   * Go to https://fonts.google.com/specimen/Roboto+Mono, and download the
 127     font. Follow the installation instructions above, as applied to this
 128 download.
 129   * Go to https://fonts.google.com/noto/specimen/Noto+Sans+Math, and
 130     download the font. Follow the installation instructions above, as
 131     applied to this download.
 132
 133 With these installed and available to **xml2rfc**, the `--pdf` switch will
 134 be enabled.
 135
 136 ### Usage
 137
 138 **xml2rfc** accepts a single XML document as input and outputs to one or
 139 more conversion formats.
 140
 141 #### Basic Usage
 142
 143 ```sh
 144 xml2rfc SOURCE [options] FORMATS...
 145 ```
 146
 147 Run `xml2rfc --help` for a full listing of command-line options.
 148
 149 ### Getting Started
 150
 151 This project is following the standard **Git Feature Workflow** development
 152 model. Learn about all the various steps of the development workflow, from
 153 creating a fork to submitting a pull request, in the [Contributing] guide.
 154
 155 > Make sure to read the [Styleguides] section to ensure a cohesive code
 156 format across the project.
 157
 158
 159 [FILE:100:distinfo]
 160 87a765b5e9c133ea5f7974708c7dabb5e66fc14ec49fe381783243207eb11238      2653005 xml2rfc-3.18.2.tar.gz
 161