rfc-tidy


Namerfc-tidy JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://github.com/martinthomson/rfc-tidy
SummaryCleanup RFC XML
upload_time2023-05-31 17:36:20
maintainer
docs_urlNone
authorMartin Thomson
requires_python>=3.7
licenseMIT
keywords rfc ietf xml
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # rfc-tidy

A simple tool that cleans up RFC XML.

## Usage

Install from pypi with:

```sh
pip install --user rfc-tidy
```

Like `black`, `rfc-tidy` cannot be tuned.  Feed XML into `stdin`, get XML
from `stdout` (it also accepts the input file as the first argument).

```sh
rfc-tidy < draft-blah-blah-blah.xml > draft-tidied.xml
```

## Features

Adds `<bcp14>` tags for your "MUST", "SHOULD", and "MAY" statements in text.

Removes extraneous XML, comments, and whitespace.

Indents elements consistently.

Replaces non-ASCII characters in text with XML numeric entities so that you
don't miss them.

Sorts attributes by name.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/martinthomson/rfc-tidy",
    "name": "rfc-tidy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "rfc,ietf,xml",
    "author": "Martin Thomson",
    "author_email": "Martin Thomson <mt@lowentropy.net>",
    "download_url": "https://files.pythonhosted.org/packages/6d/6e/ea6c72780b6cd18ff8e5688f4df91882afbf3c17d2f84e88191e0117c0d2/rfc-tidy-0.1.2.tar.gz",
    "platform": null,
    "description": "# rfc-tidy\n\nA simple tool that cleans up RFC XML.\n\n## Usage\n\nInstall from pypi with:\n\n```sh\npip install --user rfc-tidy\n```\n\nLike `black`, `rfc-tidy` cannot be tuned.  Feed XML into `stdin`, get XML\nfrom `stdout` (it also accepts the input file as the first argument).\n\n```sh\nrfc-tidy < draft-blah-blah-blah.xml > draft-tidied.xml\n```\n\n## Features\n\nAdds `<bcp14>` tags for your \"MUST\", \"SHOULD\", and \"MAY\" statements in text.\n\nRemoves extraneous XML, comments, and whitespace.\n\nIndents elements consistently.\n\nReplaces non-ASCII characters in text with XML numeric entities so that you\ndon't miss them.\n\nSorts attributes by name.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Cleanup RFC XML",
    "version": "0.1.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/martinthomson/rfc-tidy/issues",
        "Homepage": "https://github.com/martinthomson/rfc-tidy"
    },
    "split_keywords": [
        "rfc",
        "ietf",
        "xml"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ff306f3fcb335dffc02625fd5acd65125782bf61a82ad7c7f939f10cdeece2e7",
                "md5": "2beba3d44fba08721e4c6800357ea69d",
                "sha256": "50e2b7d25d352a2fe9ea81d8c24d0d08e9410db5e4f66d617b99f667282cb4e7"
            },
            "downloads": -1,
            "filename": "rfc_tidy-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2beba3d44fba08721e4c6800357ea69d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 4108,
            "upload_time": "2023-05-31T17:36:18",
            "upload_time_iso_8601": "2023-05-31T17:36:18.692448Z",
            "url": "https://files.pythonhosted.org/packages/ff/30/6f3fcb335dffc02625fd5acd65125782bf61a82ad7c7f939f10cdeece2e7/rfc_tidy-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d6eea6c72780b6cd18ff8e5688f4df91882afbf3c17d2f84e88191e0117c0d2",
                "md5": "69a5ebce70f23119be7d10d768de443f",
                "sha256": "92e4fd0c6dc12a4d5a9f92e7ba31384e24f529cc2dc0cdc4c1baa983edd34059"
            },
            "downloads": -1,
            "filename": "rfc-tidy-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "69a5ebce70f23119be7d10d768de443f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 4184,
            "upload_time": "2023-05-31T17:36:20",
            "upload_time_iso_8601": "2023-05-31T17:36:20.903587Z",
            "url": "https://files.pythonhosted.org/packages/6d/6e/ea6c72780b6cd18ff8e5688f4df91882afbf3c17d2f84e88191e0117c0d2/rfc-tidy-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-31 17:36:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "martinthomson",
    "github_project": "rfc-tidy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "rfc-tidy"
}
        
Elapsed time: 0.07396s