{ "info": { "author": "Jim Schaad", "author_email": "ietf@augustcellars.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Other Audience", "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 3.6", "Topic :: Text Processing", "Topic :: Text Processing :: Markup :: XML" ], "description": "Automatically apply errata to RFCs\n==================================\n\nThe RFC_ series is a suite of documents published by the `RFC Editor`_ for the benefit of the\nInternet community. It contains technical and organizational documents about the Internet,\nincluding the specifications and policy documents produced by four document streams within\nthe RFC series: the Internet Engineering Task Force (IETF), the Internet Research Task\nForce (IRTF), the Internet Architecture Board (IAB), and Independent Submissions. Documents\nin the RFC series are identified by a number and are frozen forever and cannot be changed.\n\nThe RFC Editor maintains a database of errata that have been submitted by the consumers of\nRFCs. These errata, once reported, can be verified, rejected or \"held for document update.\"\nThe visibility of errata to the consumers of RFCs has historically been poor or nonexistent.\nThis program is part of an effort to raise the visibility of these errata.\n\nThis program pulls down a copy of the errata database from the `RFC Editor`_ and the text version\nof an RFC_. It then merges the errata and the text of the RFC_ to produce an HTML file.\n\n.. _Internet-Draft: https://en.wikipedia.org/wiki/Internet_Draft\n.. _RFC: https://en.wikipedia.org/wiki/Request_for_Comments\n.. _RFC 7996 bis: https://datatracker.ietf.org/doc/draft-7996-bis\n.. _RFC Editor: https://www.rfc-editor.org\n\nUsage\n=====\n\nrfc-errata pulls all needed information to run from the `RFC Editor`_ website. The tool can be\nrun either to update all RFCs that have errata or only a specific set of RFCs\n\n**Basic Usage**: ``rfc-errata [options] []``\n\n**Options**\n The following parameters affect how svgcheck behaves, however none are required.\n\n =============== ======================= ==================================================\n Short Long Description\n =============== ======================= ==================================================\n ``-s`` ``--server=`` provide a server to download errata and RFCs from\n . ``--no-network`` do not download errata.json from the website\n . ``--templates=`` directory containing templates to be used\n . ``--text=`` directory to store unmodified text RFCs in\n . ``--html=`` directory to place modified HTML RFCs in\n . ``--css=`` relative location for CSS files at final website\n . ``--all`` update all RFCs rather than a list of RFCs\n . ``--reported=`` apply 'reported' errata (yes/no)\n . ``--held=`` apply 'held for update' errata (yes/no)\n . ``--rejected=`` apply 'rejected' errata (yes/no)\n . ``--verified=`` apply 'verified' errata (yes/no)\n . ``--force`` rebuild all HTML files rather than using timestamps\n . ``--nocopy`` clear destination copy list\n . ``--path`` path to css files in the HTML output\n . ``--copyto`` specify the destinations to copy to (multiple)\n ``-v`` ``--verbose`` print extra information\n ``-V`` ``--version`` display the version number and exit\n =============== ======================= ==================================================\n\nOperations\n==========\n\nThe tool can be used in a batch mode which is designed to be used in a cron job.\nFor this purpose, only the documents which have new errata will be regenerated and published to\nthe necessary locations. Documents for which errata are removed will not be regenerated as\nthere is no notification to that fact.\n\nThe tool stores information in the file status.json in the CWD. This file is used to remember\ncommand line options between different invocations of the tool. This means that, for example,\nthe set of errata to be applied is remembered between invocations and does not need to be\nspecified every time. The tool also stores the file errata.json in the CWD.\n\nWhen failures occur during processing, they are logged into the file \"errors.log\" in the CWD.\n\nThe default values for options are:\n\n- server = www.rfc-editor.org\n- templates from the installation directory of rfc-errata\n- html = ./html\n- text = ./rfc\n- css = ./css\n- reported = no\n- rejected = no\n- held = yes\n- verified = yes\n\nDependencies\n============\n\nNone\n\nChangelog\n=========\n\n\nVersion 0.2.1 (Tue 06 August)\n------------------------------------------------\n\n\n\t* Update the header template to say this is not an offical RFC\n\n\n\n\n\n\nVersion 0.2.0 (Mon 22 July)\n------------------------------------------------\n\n\n\t* Fixed an error when specifying the html directory.\n\n\n\n\n\n\nVersion 0.1.5 (Tue 18 June)\n------------------------------------------------\n\n\n\t* RFC Editor requested some changes in how the templates are worded\n\t* Fixed corner case where an entire section can disappear\n\t* Return a count of errors\n\t* Fix an error with a None field for new text", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://tools.ietf.org/tools/ietfdb/browser/brance/elft/rfc-errata/", "keywords": "RFC errata", "license": "Simplified BSD", "maintainer": "", "maintainer_email": "", "name": "rfc-errata", "package_url": "https://pypi.org/project/rfc-errata/", "platform": "", "project_url": "https://pypi.org/project/rfc-errata/", "project_urls": { "Homepage": "https://tools.ietf.org/tools/ietfdb/browser/brance/elft/rfc-errata/" }, "release_url": "https://pypi.org/project/rfc-errata/0.2.1/", "requires_dist": null, "requires_python": ">=3.3", "summary": "Build html files from the text RFCs and the errata database.", "version": "0.2.1" }, "last_serial": 5689141, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "e0c5a0eabca9022b245b0071aa1e8344", "sha256": "b596ae349a9f4995db6d69cd83fd39f10f82a7349ec4620d7d56ffb8293cdbb0" }, "downloads": -1, "filename": "rfc-errata-0.0.1.tar.gz", "has_sig": false, "md5_digest": "e0c5a0eabca9022b245b0071aa1e8344", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 22591, "upload_time": "2019-05-08T22:49:40", "url": "https://files.pythonhosted.org/packages/ab/71/b656fe88f494fd42deeeca5c2218a94634318a77dd1456830e4f7633cd69/rfc-errata-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "79ccf4bd947e454e4395764fb2dd3bc3", "sha256": "b9d008b92401aa655591c358ad961b7d8ea50f472874579c2b5bef74446bc5ad" }, "downloads": -1, "filename": "rfc-errata-0.0.2.tar.gz", "has_sig": false, "md5_digest": "79ccf4bd947e454e4395764fb2dd3bc3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 22682, "upload_time": "2019-05-09T18:27:45", "url": "https://files.pythonhosted.org/packages/cf/af/4ecd97c208e9bf4634af93ec2b6af78904685db378acbdc4538b73958ded/rfc-errata-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "c59da6e3ea0a4410721bc7099ae67767", "sha256": "f41c1a4f4d005068cc58e99df55fdf459d66728ed2fa38c537dc1957dca5ff92" }, "downloads": -1, "filename": "rfc-errata-0.0.3.tar.gz", "has_sig": false, "md5_digest": "c59da6e3ea0a4410721bc7099ae67767", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 22685, "upload_time": "2019-05-09T23:13:45", "url": "https://files.pythonhosted.org/packages/96/7f/db18d72fbb3b50905f4e4b6c3222b6bab4fd430dcb52738f533628711462/rfc-errata-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "5a512cf9655c22f4c360d0b44be5c96b", "sha256": "0eb8cd782c4380130061c80d13028235a3d40b22314ca9f945b91c0213396176" }, "downloads": -1, "filename": "rfc-errata-0.0.4.tar.gz", "has_sig": false, "md5_digest": "5a512cf9655c22f4c360d0b44be5c96b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 22714, "upload_time": "2019-05-09T23:35:43", "url": "https://files.pythonhosted.org/packages/9c/11/dc9de33363c626dced5dc2624fefae08b5636ba8cca307cb579bf35ef756/rfc-errata-0.0.4.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "228fcfe61a35b3b4f4995e8053c2929d", "sha256": "3e0ef3b5a8f183b2dad93648238e349fb09268fd046174d40ba14a536dd38830" }, "downloads": -1, "filename": "rfc-errata-0.1.0.tar.gz", "has_sig": false, "md5_digest": "228fcfe61a35b3b4f4995e8053c2929d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 22750, "upload_time": "2019-05-10T01:05:30", "url": "https://files.pythonhosted.org/packages/1c/dd/3a4ad7968397aaf1921d9198ae68ee8001ea080bb108dfc5bc08b2440f95/rfc-errata-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "9c97347de2c450507d3ad2e14a6d3910", "sha256": "146c6ac78bf0455d32b3b538f3229ac2f07ba574090d694b5a3256c827d604e2" }, "downloads": -1, "filename": "rfc-errata-0.1.1.tar.gz", "has_sig": false, "md5_digest": "9c97347de2c450507d3ad2e14a6d3910", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 22997, "upload_time": "2019-05-10T18:12:50", "url": "https://files.pythonhosted.org/packages/9d/83/26078be1cd41776f754ecd0459b94e90045d58589f370d225b52c86d166b/rfc-errata-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "e99832c76c25f39b5df5270d24f45866", "sha256": "a8a3ddd474f6574eadf48a8da85e4dccc929c3764c896425c83b34b6b006081e" }, "downloads": -1, "filename": "rfc-errata-0.1.2.tar.gz", "has_sig": false, "md5_digest": "e99832c76c25f39b5df5270d24f45866", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 25107, "upload_time": "2019-05-11T17:26:52", "url": "https://files.pythonhosted.org/packages/e8/97/aa7f9112c5759597c1ddb7a351e50458ed6cd2a8a53195a9f127d9e71fc9/rfc-errata-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "7be523ecb2be6954481a8c2422c4b92b", "sha256": "3fafe5750fca75322c0fc97c78e2fea5f449bbaf0302f7441e0b900f09b92dfd" }, "downloads": -1, "filename": "rfc-errata-0.1.3.tar.gz", "has_sig": false, "md5_digest": "7be523ecb2be6954481a8c2422c4b92b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 25364, "upload_time": "2019-05-18T17:29:11", "url": "https://files.pythonhosted.org/packages/64/57/bfd6a9075565190e83039eb07fc268783303a82c6e1be71f15a7b08a25a5/rfc-errata-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "858ef56cad13dc2c4355ffbb08190319", "sha256": "bb475eae90b3bf061ab2047d311f26235652c81ae488ea9c34ea383a71ca904d" }, "downloads": -1, "filename": "rfc-errata-0.1.4.tar.gz", "has_sig": false, "md5_digest": "858ef56cad13dc2c4355ffbb08190319", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 25610, "upload_time": "2019-06-01T02:30:59", "url": "https://files.pythonhosted.org/packages/b3/a7/6d65efc8b823fb472397e0b530b4b94826e9c8fd23a6f2562feb81f56985/rfc-errata-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "fb7b2b471099878e5b6e6374facc99d4", "sha256": "fe933556618c49685995f27d73747246b9490214661a5ac198f26cf0b60f0f7c" }, "downloads": -1, "filename": "rfc-errata-0.1.5.tar.gz", "has_sig": false, "md5_digest": "fb7b2b471099878e5b6e6374facc99d4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 25308, "upload_time": "2019-06-19T01:06:09", "url": "https://files.pythonhosted.org/packages/e2/62/cdd3cdc6ae64e30f860b02731c860ff95a5ac93c6fc484f47a0c0e14f267/rfc-errata-0.1.5.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "cdb7da26d11c581e3ae0342171f898f0", "sha256": "fc9e121fa112434c4c2c87d66427cab27dfd0ce5ab0ccdf5ed0fb72813909fc7" }, "downloads": -1, "filename": "rfc-errata-0.2.0.tar.gz", "has_sig": false, "md5_digest": "cdb7da26d11c581e3ae0342171f898f0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 25346, "upload_time": "2019-07-23T00:24:36", "url": "https://files.pythonhosted.org/packages/61/27/a4395cbcbb33292ab6c2b2cf897a157320419a2e934f74f6424f93a4a61c/rfc-errata-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "8aa449de2a4096848a4be879fca39bbb", "sha256": "ebfb462a8469d9585ad2e32c65d9628342a7a244fa2208fd43765a614af62e7e" }, "downloads": -1, "filename": "rfc-errata-0.2.1.tar.gz", "has_sig": false, "md5_digest": "8aa449de2a4096848a4be879fca39bbb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 25587, "upload_time": "2019-08-16T19:13:53", "url": "https://files.pythonhosted.org/packages/11/e5/2d0ab27001b23dd6d773ddd590b87c188f9a80cc9a51f585c1864cff6f1d/rfc-errata-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8aa449de2a4096848a4be879fca39bbb", "sha256": "ebfb462a8469d9585ad2e32c65d9628342a7a244fa2208fd43765a614af62e7e" }, "downloads": -1, "filename": "rfc-errata-0.2.1.tar.gz", "has_sig": false, "md5_digest": "8aa449de2a4096848a4be879fca39bbb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.3", "size": 25587, "upload_time": "2019-08-16T19:13:53", "url": "https://files.pythonhosted.org/packages/11/e5/2d0ab27001b23dd6d773ddd590b87c188f9a80cc9a51f585c1864cff6f1d/rfc-errata-0.2.1.tar.gz" } ] }