{
"info": {
"author": "Honza Javorek",
"author_email": "mail@honzajavorek.cz",
"bugtrack_url": null,
"classifiers": [],
"description": "Copyright (c) 2017-? Honza Javorek\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\nDescription: rtd-redirects\n =============\n \n |PyPI version| |Build Status|\n \n Manage redirects in the `ReadTheDocs `__ admin, programmatically.\n \n Installation\n ------------\n \n Requires **Python 3.6** and higher.\n \n .. code:: sh\n \n $ pip install rtd-redirects\n \n Usage\n -----\n \n .. code:: sh\n \n $ rtd-redirects project-name ./redirects.yml --username=honzajavorek\n \n Uploads redirects defined in the ``redirects.yml`` file to ReadTheDocs redirects administration of the ``project-name`` project.\n \n The tool uses ReadTheDocs' HTML interface (there's no official API for redirects), so you need to provide your username and password. HTTPS is used to transfer the credentials to ReadTheDocs.\n \n ``rtd-redirects`` tries to be idempotent, i.e. you can run it several times in row and it should always end with the same results. If there are any redirects with the same source path, the tool will replace them with whatever is defined in the ``redirects.yml`` file. Existing redirects which do not collide with contents of ``redirects.yml`` won't be affected.\n \n redirects.yml\n -------------\n \n Only **page redirects** are supported at the moment. The format of the file is as follows:\n \n .. code:: yaml\n \n redirects:\n # Following redirects have to be done because we've migrated from MkDocs to Sphinx\n \"/example/\": \"/example.html\"\n \"/python/\": \"/python.html\"\n \n # Following pages has been removed in favor of sections\n \"/green.html\": \"/colors.html#green\"\n \n # Following redirects are only for convenience\n \"/praha.html\": \"/prague.html\"\n \n Why `YAML `__? Because it's easy to read by humans, easy to write by humans, and above all, it has support for comments. Redirects are *corrections* and you should document why they're necessary.\n \n License: MIT\n ------------\n \n \u00a9 2017-? Honza Javorek mail@honzajavorek.cz\n \n This work is licensed under `MIT\n license `__.\n \n .. |PyPI version| image:: https://badge.fury.io/py/rtd-redirects.svg\n :target: https://badge.fury.io/py/rtd-redirects\n .. |Build Status| image:: https://travis-ci.org/honzajavorek/rtd-redirects.svg?branch=master\n :target: https://travis-ci.org/honzajavorek/rtd-redirects\n \nKeywords: readthedocs documentation redirects sphinx mkdocs\nPlatform: UNKNOWN\nClassifier: Development Status :: 5 - Production/Stable\nClassifier: Intended Audience :: Developers\nClassifier: Intended Audience :: Information Technology\nClassifier: License :: OSI Approved :: MIT License\nClassifier: Programming Language :: Python\nClassifier: Programming Language :: Python :: 3\nClassifier: Programming Language :: Python :: 3.6\nClassifier: Programming Language :: Python :: 3 :: Only\nClassifier: Topic :: Documentation\nClassifier: Topic :: Documentation :: Sphinx\nClassifier: Topic :: Software Development :: Documentation\nClassifier: Topic :: Internet\n",
"description_content_type": null,
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/honzajavorek/rtd-redirects",
"keywords": "",
"license": "MIT License",
"maintainer": "",
"maintainer_email": "",
"name": "rtd-redirects",
"package_url": "https://pypi.org/project/rtd-redirects/",
"platform": "",
"project_url": "https://pypi.org/project/rtd-redirects/",
"project_urls": {
"Homepage": "https://github.com/honzajavorek/rtd-redirects"
},
"release_url": "https://pypi.org/project/rtd-redirects/1.0.1/",
"requires_dist": [
"click",
"cssselect",
"lxml",
"pyaml",
"requests",
"python-semantic-release; extra == 'release'",
"flake8; extra == 'tests'"
],
"requires_python": "",
"summary": "Manage redirects in the ReadTheDocs admin, programmatically",
"version": "1.0.1"
},
"last_serial": 2990312,
"releases": {
"1.0.1": [
{
"comment_text": "",
"digests": {
"md5": "07967325700a038ccca4b57f41dd511d",
"sha256": "cb52cbffd6d16246942baf5d3442e8b72e42229a56e4a48193cd060e78375432"
},
"downloads": -1,
"filename": "rtd_redirects-1.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "07967325700a038ccca4b57f41dd511d",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7008,
"upload_time": "2017-06-30T16:33:37",
"url": "https://files.pythonhosted.org/packages/b3/6a/dc0d014e9180b29d65ec06889af22aab22c88714ad2a0f9d6fd51096bca2/rtd_redirects-1.0.1-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "9a51a27643451799c09efad931d595da",
"sha256": "cebdaa290dcca3cbeb43bb22251d3faa767e509c0ef8aee69ba2bcfa24ce18eb"
},
"downloads": -1,
"filename": "rtd-redirects-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9a51a27643451799c09efad931d595da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4313,
"upload_time": "2017-06-30T16:33:40",
"url": "https://files.pythonhosted.org/packages/52/2c/0756c1b3f2089a86c8590ca850b9ed3b620682ec811b2685a32127a0f918/rtd-redirects-1.0.1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "07967325700a038ccca4b57f41dd511d",
"sha256": "cb52cbffd6d16246942baf5d3442e8b72e42229a56e4a48193cd060e78375432"
},
"downloads": -1,
"filename": "rtd_redirects-1.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "07967325700a038ccca4b57f41dd511d",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7008,
"upload_time": "2017-06-30T16:33:37",
"url": "https://files.pythonhosted.org/packages/b3/6a/dc0d014e9180b29d65ec06889af22aab22c88714ad2a0f9d6fd51096bca2/rtd_redirects-1.0.1-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "9a51a27643451799c09efad931d595da",
"sha256": "cebdaa290dcca3cbeb43bb22251d3faa767e509c0ef8aee69ba2bcfa24ce18eb"
},
"downloads": -1,
"filename": "rtd-redirects-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9a51a27643451799c09efad931d595da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4313,
"upload_time": "2017-06-30T16:33:40",
"url": "https://files.pythonhosted.org/packages/52/2c/0756c1b3f2089a86c8590ca850b9ed3b620682ec811b2685a32127a0f918/rtd-redirects-1.0.1.tar.gz"
}
]
}