{
    "info": {
        "author": "Alessandro Bacchini",
        "author_email": "allebacco@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Web Environment",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3",
            "Topic :: Documentation",
            "Topic :: Software Development :: Documentation"
        ],
        "description": "# List The Docs\n\nList The Docs allows to collect the documentation of projects hosted in\ndifferent servers in the same page.\n\nSee full documentation at https://allebacco.github.io/listthedocs/.\n\nList The Docs does not (actually) provides documentation hosting, but it\noffer only a web page with a nice list of project and documentation links.\n\nThis work has been started from [Host the Docs](https://github.com/rgalanakis/hostthedocs),\nbut has lead to a complete rewrite of the code and the aim of the project.\n\nThe project is written in Python using Flask.\n\n## Start the server\n\nSince List The Docs is writte using Flask it can be execute with the follwing\ncommands:\n\n    export FLASK_APP=listthedocs\n    flask run\n    * Running on http://127.0.0.1:5000/\n\nFor Windows commandline use:\n\n    set FLASK_APP=listthedocs\n\nAnd for Windows Powershell use:\n\n    $env:FLASK_APP=\"listthedocs\"\n\n### Configuration\n\nThe service can be configured with a Python file `config.py` that can be placed in the app\n\"instance_path\" (https://flask.palletsprojects.com/en/1.0.x/config/#instance-folders).\n\nThe *instance_path* can be customized by setting the *INSTANCE_PATH* to an absolute path.\n\nThe configuration is loaded from the `config.py` in the *instance_path*:\n\n- **DATABASE_URI**: Database connection URI. Default to an SQLite database.\n- **COPYRIGHT**: The copyright footer message. HTML is allowed.\n- **TITLE**: The title of the web pages.\n- **HEADER**: The header of the web page. HTML is allowed.\n- **READONLY**: Set to true to disable the write REST APIs.\n- **LOGIN_DISABLED**: Disable the login and security.\n- **ROOT_API_KEY**: The Api-Key for the `root` user. Default `ROOT-API-KEY`.\n\n### Usage\n\nThe service provides a set of REST APIs to manage projects and versions.\n\n#### Build and Host documentation\n\nBefore using the APIs, you should build the documentation (e.g. with Sphinx, MkDocs, \nDoxygen, ...) and host it on a web server. List The Docs does not actuallt provides \ndocuemntation hosting services.\n\n#### Collect documentations in List The Docs\n\nAfter deploying a (new) project documentation on a hosting service, you can visualize\nit in List The Docs:\n\n1. Add the project (if not already present)\n2. Add the version to the project\n\n##### Add a project to List The Docs\n\nAdding a project to List The Docs can be done using the following REST API:\n\n``` python\nimport requests\n\nresponse = requests.post(\n    'http://localhost:5000/api/v1/projects', \n    json={\n        'title': 'Project Title',\n        'description': 'The description of the project',\n    }\n)\n\n# The response contains the `name` of the project\n```\n\n##### Add a documentation version link to List The Docs\n\nAdding a version for a project documentation to List The Docs can be done \nusing the following REST API:\n\n``` python\nimport requests\n\nrequests.post(\n    'http://localhost:5000/api/v1/projects/<project-name>/versions', \n    json={\n        'name': '1.0.0',\n        'url': 'http://www.example.com/doc/1.0.0/index.html',\n    }\n)\n```\n\n\n### Python Client\n\nTo simplify the management of the projects, List The Docs provides a \nsimple Python client:\n\n``` python\nfrom listthedocs.client import ListTheDocs, Project, Version\n\nclient = ListTheDocs()\nproject = client.add_project(\n    Project(title='Project Title', description='description')\n)\nclient.add_version(\n    project, \n    Version('1.0.0', 'http://www.example.com/doc/1.0.0/index.html')\n)\n```\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/allebacco/listthedocs",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "listthedocs",
        "package_url": "https://pypi.org/project/listthedocs/",
        "platform": "",
        "project_url": "https://pypi.org/project/listthedocs/",
        "project_urls": {
            "Homepage": "https://github.com/allebacco/listthedocs"
        },
        "release_url": "https://pypi.org/project/listthedocs/2.0.1/",
        "requires_dist": [
            "natsort",
            "requests",
            "attrs",
            "python-dateutil",
            "Flask-SQLAlchemy",
            "Flask"
        ],
        "requires_python": ">=3.5",
        "summary": "List your documentations",
        "version": "2.0.1"
    },
    "last_serial": 5899713,
    "releases": {
        "1.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "177b78d1f8547d87e3bc7213ce1080b2",
                    "sha256": "d8273b4b8f247e02519f037d464deee34da46608bef16205d9d34f92644bd187"
                },
                "downloads": -1,
                "filename": "listthedocs-1.0.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "177b78d1f8547d87e3bc7213ce1080b2",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 21099,
                "upload_time": "2019-09-28T07:59:54",
                "url": "https://files.pythonhosted.org/packages/a7/cb/e64a24173d098ec1316ccd585f749d1253642fad2489c7b1d95b02e0b4ed/listthedocs-1.0.4-py3-none-any.whl"
            }
        ],
        "2.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f1d70741e4ec4516b382211179928158",
                    "sha256": "dc5b411b2c2c4376e9aeb40e07e3ac7366c1d4a452df487b42e9985aff7ba549"
                },
                "downloads": -1,
                "filename": "listthedocs-2.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f1d70741e4ec4516b382211179928158",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 21720,
                "upload_time": "2019-09-28T13:32:52",
                "url": "https://files.pythonhosted.org/packages/15/68/271cb27a2f1927fb5cb6508c6880b456494d481cd33458571036ecc952d4/listthedocs-2.0.0-py3-none-any.whl"
            }
        ],
        "2.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "56d515cdf5a4e1b255f032079a17c2fd",
                    "sha256": "c95dd671b595bbd7c35f67f16e8b10c8fcd18182aee8050dedd4794634bc942c"
                },
                "downloads": -1,
                "filename": "listthedocs-2.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "56d515cdf5a4e1b255f032079a17c2fd",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 21764,
                "upload_time": "2019-09-28T13:39:19",
                "url": "https://files.pythonhosted.org/packages/d0/fa/2f88e805e55370f4e7be273627a75149440fcb7a5c31549c8c08b564fb40/listthedocs-2.0.1-py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "56d515cdf5a4e1b255f032079a17c2fd",
                "sha256": "c95dd671b595bbd7c35f67f16e8b10c8fcd18182aee8050dedd4794634bc942c"
            },
            "downloads": -1,
            "filename": "listthedocs-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "56d515cdf5a4e1b255f032079a17c2fd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 21764,
            "upload_time": "2019-09-28T13:39:19",
            "url": "https://files.pythonhosted.org/packages/d0/fa/2f88e805e55370f4e7be273627a75149440fcb7a5c31549c8c08b564fb40/listthedocs-2.0.1-py3-none-any.whl"
        }
    ]
}