xml2rfc 3.26.0__py3-none-any.whl

xml2rfc-3.26.0.dist-info/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, IETF Trust
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

xml2rfc-3.26.0.dist-info/METADATA

@@ -0,0 +1,178 @@
+Metadata-Version: 2.2
+Name: xml2rfc
+Version: 3.26.0
+Summary: xml2rfc generates RFCs and IETF drafts from document source in XML according to the IETF xml2rfc v2 and v3 vocabularies.
+Author: Henrik Levkowetz
+Maintainer-email: IETF Tools <tools-help@ietf.org>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2022, IETF Trust
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: homepage, https://github.com/ietf-tools/xml2rfc
+Project-URL: source, https://github.com/ietf-tools/xml2rfc
+Project-URL: changelog, https://github.com/ietf-tools/xml2rfc/blob/main/CHANGELOG.md
+Project-URL: releasenotes, https://github.com/ietf-tools/xml2rfc/releases
+Project-URL: documentation, https://ietf-tools.github.io/xml2rfc/
+Project-URL: issues, https://github.com/ietf-tools/xml2rfc/issues
+Keywords: ietf,rfc,id,internet-draft,xml,xml2rfc,xmlrfc
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Text Processing :: Markup :: XML
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: platformdirs>=3.6.0
+Requires-Dist: configargparse>=1.2.3
+Requires-Dist: google-i18n-address>=3.0.0
+Requires-Dist: intervaltree>=3.1.0
+Requires-Dist: jinja2>=3.1.2
+Requires-Dist: lxml>=5.3.0
+Requires-Dist: pycountry>=22.3.5
+Requires-Dist: pyyaml>=5.3.1
+Requires-Dist: requests>=2.5.0
+Requires-Dist: setuptools>=24.2.0
+Requires-Dist: wcwidth>=0.2.5
+Provides-Extra: pdf
+Requires-Dist: weasyprint==61.2; extra == "pdf"
+Requires-Dist: pydyf<0.10.0; extra == "pdf"
+
+<div align="center">
+    
+<img src="https://raw.githubusercontent.com/ietf-tools/common/main/assets/logos/xml2rfc.svg" alt="XML2RFC" height="125" />
+    
+[![Release](https://img.shields.io/github/release/ietf-tools/xml2rfc.svg?style=flat&maxAge=600)](https://github.com/ietf-tools/xml2rfc/releases)
+[![License](https://img.shields.io/github/license/ietf-tools/xml2rfc)](https://github.com/ietf-tools/xml2rfc/blob/main/LICENSE)
+[![PyPI - Version](https://img.shields.io/pypi/v/xml2rfc)](https://pypi.org/project/xml2rfc/)
+[![PyPI - Status](https://img.shields.io/pypi/status/xml2rfc)](https://pypi.org/project/xml2rfc/)
+[![PyPI - Format](https://img.shields.io/pypi/format/xml2rfc)](https://pypi.org/project/xml2rfc/)
+    
+##### Generate RFCs and IETF drafts from document source in XML according to the IETF xml2rfc v2 and v3 vocabularies
+    
+</div>
+
+- [Changelog](https://github.com/ietf-tools/xml2rfc/blob/main/CHANGELOG.md)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md)
+- [Getting Started](#getting-started)
+    - [Git Cloning Tips](#git-cloning-tips)
+    - [Docker Dev Environment](#docker-dev-environment)
+- [Release Procedure](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md#release-procedure)
+
+---
+
+### 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)*. 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.
+
+### Installation
+
+Installation of the python package is done as usual with `pip install xml2rfc`, using appropriate switches.
+
+#### 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.
+
+```sh
+pip install "xml2rfc[pdf]"
+```
+3. Finally, install the required fonts:
+  * Download latest fonts from [xml2rfc-fonts](https://github.com/ietf-tools/xml2rfc-fonts/releases/latest).
+  * 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.
+
+### Usage
+
+**xml2rfc** accepts a single XML document as input and outputs to one or more conversion formats.
+
+#### Basic Usage
+
+```sh
+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](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md) guide.
+
+> Make sure to read the [Styleguides](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md#styleguides) section to ensure a cohesive code format across the project.
+
+You can submit bug reports, enhancements and new feature requests in the [discussions](https://github.com/ietf-tools/xml2rfc/discussions) area. Accepted tickets will be converted to issues.
+
+#### Git Cloning Tips
+
+As outlined in the [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md) 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)*:
+
+```sh
+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.
+
+
+```sh
+./run.sh
+```
+
+[IETF]: https://www.ietf.org/
+[RFCs]: https://www.rfc-editor.org/
+[RFC7749]: https://www.rfc-editor.org/info/rfc7749
+[RFC7991]: https://www.rfc-editor.org/info/rfc7991
+[bis draft for 7991]: https://datatracker.ietf.org/doc/draft-iab-rfc7991bis/
+[v3.rng]: xml2rfc/data/v3.rng
+[documentation xml2rfc produces]: https://ietf-tools.github.io/xml2rfc/
+[preptool]: https://www.rfc-editor.org/info/rfc7998
+[WeasyPrint]: https://weasyprint.org/
+[WeasyPrint Docs]: https://doc.courtbouillon.org/weasyprint/stable/first_steps.html

xml2rfc-3.26.0.dist-info/RECORD

@@ -0,0 +1,71 @@
+xml2rfc/__init__.py,sha256=42KU_RggSrKeKGo6u_WE86Ybjuhr3WRf9cg9-WVf-Zs,2427
+xml2rfc/boilerplate_id_guidelines.py,sha256=WJG3s1jH2V4XFgC11QPL2sQep2RvXF___tMyiRLOgFw,1173
+xml2rfc/boilerplate_rfc_7841.py,sha256=w_I8WURkXhRd3Jor2ikSKLkSAI1fMt2f9o9swM422Bg,25978
+xml2rfc/boilerplate_tlp.py,sha256=BsgzApqrmbWkPeIkBAUwx_x9tHZ7hO19OsG649CJ2mo,11639
+xml2rfc/debug.py,sha256=PjFIOV8TVIxe3ycMWRyFDbKjxR-j1CqcRsnsYrllSxo,6947
+xml2rfc/log.py,sha256=U21sjQJVSIaLy9rMR80R17wyetbrJhs747N0qd8yTYs,1585
+xml2rfc/parser.py,sha256=v6YJJK1hm7gSvvf4ZzbfknHAFHH-Q27eQlud0HzZJpk,37221
+xml2rfc/run.py,sha256=XdH2yn_FhSTBukNsC_7w4PcUsBjei7jGzsf49GGYPfU,39170
+xml2rfc/scripts.py,sha256=sSP3H3OW4Gflbwb8Y6mg_WWTjSPNz7B5yDgU1qaqNRo,1502
+xml2rfc/strings.py,sha256=9xj0wW1LcaIWd1QeY5_OWEEZA3rpmJXE0zTTRgEExlY,722
+xml2rfc/utils.py,sha256=evSFbvuGVHp-HBqoMzKRuYJdbkY3TseHef-9g-yDb1M,23047
+xml2rfc/walkpdf.py,sha256=GAhYK-XeFdwBtilobb2bjBY1rJTafP9HfQQDW57yt6I,3547
+xml2rfc/data/SVG-1.2-RFC.rnc,sha256=AQXGCX7L0PLFT3ZJYt6auVd9R4__XOUoXKI8kxVZFao,60523
+xml2rfc/data/SVG-1.2-RFC.rng,sha256=hGDFO1u0zKfnYQr8nXH0SqGG8t6an9Ut_dPLrK-kfaQ,209128
+xml2rfc/data/Scripts.txt,sha256=0C4k5MUW6QkLa8nC0sj0yJUQtu2MXoWdCoYbDcXPNy0,164026
+xml2rfc/data/metadata.js,sha256=ZDsu3oyWFvf6GppEJ02To7jzTZCkKzUeTNa1d0ws2aU,9969
+xml2rfc/data/metadata.min.js,sha256=YAJ-yOWgCrBNDHyoIO2-_PWz1kClRrE68JmZdoodF_w,3159
+xml2rfc/data/reference.rnc,sha256=wsJJkRWAdY19EAdHalVjjzDgnjpprO861BCFcd155yo,22329
+xml2rfc/data/reference.rng,sha256=OUQXRD2QSKhoXlkkoEcXifNlR84sw6mtnAre6UjkFqk,52191
+xml2rfc/data/referencegroup.rnc,sha256=d8gWh3dFgWCpW6bxkMbtl-B0FacpuFxdfmfh7EIs3DM,428
+xml2rfc/data/referencegroup.rng,sha256=AMyVM1CkQ73r39gmEMxKBBj-5Ym7GsMrI2OL5_bVD0A,52734
+xml2rfc/data/rfc7991.rnc,sha256=RUCYjIXYRYZCMg7LbvpIVlDk3VKAhYDn6fnEo-xq5wk,22749
+xml2rfc/data/rfc7991.rng,sha256=k0axvrWcU4lvpZxkwZQl0487VsaGQhxZ-JD0fNudAVs,51877
+xml2rfc/data/v2.rnc,sha256=Rgy1-GooJE0DoYdKs6vTqeKh4RgyEbTGH4sa4s4DjHA,7330
+xml2rfc/data/v2.rng,sha256=di3BDkCTu16ETH0xB-UnGM667pOzERTTPFiBexqX7HU,17354
+xml2rfc/data/v3.rnc,sha256=A_5y8ZhL0V5qosVzK-gc_ucJ5qDVL55b63yWrc_Z930,26930
+xml2rfc/data/v3.rng,sha256=jS-FgKCsX8BQ6oDg7Ik106nvQH-uTz7HJp2QXl682rU,61718
+xml2rfc/data/v3compat.dtd,sha256=WFk4mDamsns6tYgS7NNO0I0WgG9Q-FzOq0jguiYGTPU,14886
+xml2rfc/data/v3compat.rnc,sha256=YrAcV1iAU1H_STCeUv81ByFMOs2u_XlcGtNAeTLV0o8,23997
+xml2rfc/data/xml2rfc-v3-emacs-nxml.rnc,sha256=TExHipZeachXSxAj5MpJxy-Vpr-Z0p_zo1KYAYdy32w,25850
+xml2rfc/data/xml2rfc.css,sha256=bTsFjYq3Cgb7WppUUONeHw4ueVVUZHf-hl3AuXt8m_w,22930
+xml2rfc/data/xml2rfc.js,sha256=b9VX7P2krASK_4FsQMkNF-g8oHgwQ9OLoFfnGTt4cV4,235
+xml2rfc/templates/address_card.html,sha256=cve9CtLs77y5P_ePHsrw63ycOi_uVc8vPZcLf2nNtsE,576
+xml2rfc/templates/base.html,sha256=4Fj0oN5obOCehGMwvVDhzOpxYI7zBn_LZiNjM0022-g,7268
+xml2rfc/templates/doc.xml,sha256=K1h3ZVCH-NgAv_9D1uw21EelWHkWFj9vuiioc0rruuI,14078
+xml2rfc/templates/doc.yaml,sha256=7zYTj-cAQEq8BPSK9KElkicoVU_G6d2UmeIQ0sijyb0,84682
+xml2rfc/templates/rfc2629-other.ent,sha256=EC6wh_rjkI--M3nJjGARz57YfzGg1XwgVAVkQhwiHn0,3756
+xml2rfc/templates/rfc2629-xhtml.ent,sha256=pCCf2EPVjnyHcuY5maMjF-Hz-lAXsbqjf74dlmCTOJY,15829
+xml2rfc/templates/rfc2629.dtd,sha256=IZLYjK9IQApLhhFAeuKxnd0CZytaGL2HTTWTGVulfIw,9817
+xml2rfc/uniscripts/__init__.py,sha256=SsrOy8WgFDwRmkT16b0aRBfUZMsv3TpE7pASu9la1p8,2747
+xml2rfc/uniscripts/unidata.py,sha256=UaDORWLoVDQ99WwQ-WaJWMFt99o-DmqAJ3NZ-1Re--g,57311
+xml2rfc/uniscripts/update/make_unidata.py,sha256=UYX39rZNWgYuI9B8JWqGtN-1RtR1VbU_cW8eWRxTI8g,2268
+xml2rfc/util/__init__.py,sha256=g6ytwc9MuqsiFYmVRnl-V8-UIpGiweDgpAXcufayMOA,231
+xml2rfc/util/date.py,sha256=BmBGyYdyOoK0X_dtaawCaixhow-9np31mFpfx46RD30,2792
+xml2rfc/util/fonts.py,sha256=nkPBJKdBU02Bf0TnxNFkrHZM7--WWXA_BrrZXH28SUw,2003
+xml2rfc/util/name.py,sha256=c1B4T1Wb8x4zQ5h5Y990twK6LYC6AVd28SmVH-Zd_2A,6792
+xml2rfc/util/num.py,sha256=pnSwwpdV6Kt0ChSFzleplT_gygc_xi2Mrf6Uwo4UrF8,3536
+xml2rfc/util/postal.py,sha256=y_Hm2aHk4AbJI8puOxr3IKvwlIyTampBcFA_-K4pmm0,11187
+xml2rfc/util/unicode.py,sha256=SWrFER0AG2nbIo8nHd7k_P84pOqLedj-RGqV--An5P8,11033
+xml2rfc/writers/__init__.py,sha256=bwYcnmQ1oaJINQTrQ_V_bcylLfYNddnT815Ke7ekE8w,1234
+xml2rfc/writers/base.py,sha256=iZGUTCdZhXEtQ6HsCWsusWQXmlqw8X0dH8b1gEo1uaw,93625
+xml2rfc/writers/bib.py,sha256=m0VxVxSQ0Xo0crEpAVJFR_ZLAhVsuGoikOje5HFFX6I,1601
+xml2rfc/writers/doc.py,sha256=Fqq29nKCy9i7FPpQc6crKXBSwP9PobE-l6P6jS1IlYY,15143
+xml2rfc/writers/expand.py,sha256=6AVOUWy1fAtzwAL5QvLoSOxqpfTg_ZwQKaiubjybMQU,1887
+xml2rfc/writers/expanded_xml.py,sha256=fyrXChvKXRvt9hr-vlJMDYc3Tvj9A0MY3O3_vaR9uG4,1514
+xml2rfc/writers/html.py,sha256=NXu6_hCOa3gij7BM7LoLcGpFkd1vV_xmPzo6t4nws74,125910
+xml2rfc/writers/legacy_html.py,sha256=-KzP99hsOxQFG8DQAU6mVP5vI_r1tkCBrZ2g_NLg6hs,34760
+xml2rfc/writers/nroff.py,sha256=sxKQG3pQHkQgRFbf6ii4oN1bJ2TmoPHJx78iVWV4mP4,12675
+xml2rfc/writers/paginated_txt.py,sha256=H00Bomwqom0sffw-euhPzjyynxfd72ZpC1-GKJnKnGA,18319
+xml2rfc/writers/pdf.py,sha256=qLCXONrFsjjKQMyJfrrXruC6N6s_gakwxiZQFAO9pVE,6559
+xml2rfc/writers/preptool.py,sha256=1I86jrU5hnTHiq8rHiDUdsnzjLlxR44Vt7ANqiIDC9k,113947
+xml2rfc/writers/raw_txt.py,sha256=XcQItofIam7QoiMX968ySuZEJag1eSUrx8YEA0Cv7zM,60693
+xml2rfc/writers/text.py,sha256=IWXqfznuRIQVN-K6TJW2mEL26vNz1U8bYwCLUvsCM28,191653
+xml2rfc/writers/unprep.py,sha256=QX_5lTBfDJB5vHtrgibC1Xny--sXzLGGLX2GtyWB_Cg,6962
+xml2rfc/writers/v2v3.py,sha256=gLqIZHMPsNOOMTJ84WCpTgtuZlCjhyQNQpfqYE9opb0,42408
+xml2rfc-3.26.0.dist-info/LICENSE,sha256=uD_ACdCpCORVFSrOT1WVVg1nVLzD2swjfEGe6Isi6cg,1518
+xml2rfc-3.26.0.dist-info/METADATA,sha256=T6kyX-IP2xk4_2NLyDMbqWQVqqHFXi0qWCYeJRhvGqI,9240
+xml2rfc-3.26.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+xml2rfc-3.26.0.dist-info/entry_points.txt,sha256=q25DQMYmr8WZWdbo3ouWq_UaUf8Rb7CPBqICjXjaTMg,45
+xml2rfc-3.26.0.dist-info/top_level.txt,sha256=1D9kObWHSGpKgZ5XHX4BuzIsodpeSpsCMGaaDy0Chec,8
+xml2rfc-3.26.0.dist-info/RECORD,,

xml2rfc-3.26.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

xml2rfc-3.26.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+xml2rfc = xml2rfc.run:main

xml2rfc-3.26.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+xml2rfc