{
    "info": {
        "author": "Hardy & Ellis Inventions LTD",
        "author_email": "support@heinventions.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3"
        ],
        "description": "# DocServe\n\nA tool for quick and easy Markdown project documentation.\n\nDocServe renders an adapted Markdown to provide:\n\n* Images, Video, YouTube links, CSV tables.\n* Code highlighting.\n* File download blocks.\n* Lists and Tables.\n* Document defined template selection.\n* Document Meta-data.\n* Auto-generated index sidebar.\n\nDocServe can be used as a server to:\n\n* Output documents as insecure HTML on a localhost.\n* Output documents as PDF files via the HTML server.\n\nDocServe can also:\n\n* Create a **static** set of HTML files that contain the documentation and related resources.\n\nBasic usage with the default template:\n\n```bash\npython -m pip install docserve\nmkdir docs\nvim docs/home.md # then add some documentation\ndocserve\n```\n\nBasic usage with a custom template:\n\n```bash\npython -m pip install docserve\ndocserve --new # copies sample style and docs into working directory\ndocserve # run the server\n```\n\n## Roadmap\n\nWe are requesting pull-requests for the following features:\n\n* [ ] Clearer heading CSS. H1 and H2 are confusing.\n* [ ] Test cases and CI steps\n* [ ] Reload on new files.\n* [ ] Windows EXE bundle for non-developer use.\n* [ ] Responsive design in default template.\n* [ ] Generate a large PDF file made from multiple documents (including table of contents with page numbers).\n* [ ] Gravatar print CSS / absent internet in the default theme.\n* [ ] Examples of Python extensions and SCSS extensions.\n* [ ] New template themes.\n\n## Getting Started\n\nIf you are running from the script:\n\n```bash\npython docserve.py                       # start a server on localhost:5000\n\npython docserve.py --html                # freeze the server into a static site as a set of HTML files\n                                         # this will exit with -1 if there was a problem parsing any file\n\npython docserve.py --port                # specify a port for docserve to accept requests on\n\npython docserve.py --pdf                 # generate a set of pdf files for each .md file - won't pull through\n                                         # static resource files like with the --html command\n\npython docserve.py --new                 # copy default templates and sample docs into the working directory\n                                         # and update the config too, only if they don't already exist\n\npython docserve.py --new-force           # copy default templates and sample docs into the working directory\n                                         # and update the config too, this will overwrite any existing docs or\n                                         # configs.\n\n\npython docserve.py --dirs                # display all the different directories docserve will use to generate\n                                         # the documentation\n\npython docserve.py --find-orphans        # display unreferenced media assets in the documentation\npython docserve.py --find-broken-links   # display external broken links in the documentation\n```\n\n### Writing Documentation\n\nDocuments are managed using `meta-data` at the top of each document.\nDocuments can select which `template` they present themselves with.\nDocuments must end in **lowercase** `.md`. For example: `mydocument.md`.\n\n\n### Environment variables\n\n* `DS_FLASK_DEBUG` flag for enabling or disabling flask debug. Defaults to `TRUE`.\n* `DS_FLASK_CHANGERELOAD` flag for reloading the server when a file changes. Defaults to `TRUE`. If set, this forces `DS_FLASK_DEBUG` to `TRUE`.\n* `DS_WKHTMLTOPDF` the path to the WkHTMLtoPDF binary. Defaults to `wkhtmltopdf_0.12.5.exe`.\n* `DS_DOCS_DIR` the path to the directory that contains the documents. Defaults to `docs`.\n* `DS_STYLE_DIR` the path to the directory that contains the style templates and resources. Defaults to `style`.\n* `DS_PROJECT_LOGO` the path to the project logo *PNG* file. Defaults to `logo.png` in the current working directory.\n\n## Development\n\n### Virtual Environment\n\n```python\npython -m virtualenv env\nenv/Scripts/activate.bat # or the bash equivalent\npip install -r requirements.txt\n```\n\n```python\npython docserve.py # with options\n```\n\n```python\npip install flake8\nflake8 docserve.py --max-line-length=120\n```\n\n### WkHTMLtoPDF\n\nTo enable PDF output, WkHTMLtoPDF must be set in the config `DS_WKHTMLTOPDF` or `wkhtmltopdf_0.12.5.exe` placed in working directory.\n\nThis build uses version 0.12.5. Get it from here: https://wkhtmltopdf.org/downloads.html\n\n### SCSS\n\nThe default theme is built using SCSS.\n\nThe SASSC compiler can be found here: http://libsass.ocbnet.ch/installer/\nUsage: `sassc style/static/default.scss style/static/default.css`\n\nIf you want it to auto-watch, run as admin from this directory, and remember to disable your browser cache:\n\n```bash\npip install watchdog\nwatchmedo shell-command --patterns=\"*.scss\" --recursive --command='echo \"${watch_src_path}\" && sassc style/static/default.scss style/static/default.css' .\n````\n\n### Style\n\nWe use `flake8 docserve.py --max-line-length=110` to static check the code.\n\n### Rebuilding the Package\n\n```\npython -m pip install --user --upgrade setuptools wheel twine\npython setup.py sdist bdist_wheel\n\npython -m twine upload dist/*\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/HEInventions/DocServe",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "docserve",
        "package_url": "https://pypi.org/project/docserve/",
        "platform": "",
        "project_url": "https://pypi.org/project/docserve/",
        "project_urls": {
            "Homepage": "https://github.com/HEInventions/DocServe"
        },
        "release_url": "https://pypi.org/project/docserve/0.9.7/",
        "requires_dist": [
            "Flask (==1.0.2)",
            "Markdown (==2.6.11)",
            "timeago (==1.0.8)",
            "Frozen-Flask (==0.15)",
            "beautifulsoup4 (==4.6.3)",
            "requests (==2.19.1)"
        ],
        "requires_python": ">=3.6.0",
        "summary": "A tool for quick and easy Markdown project documentation.",
        "version": "0.9.7"
    },
    "last_serial": 4204634,
    "releases": {
        "0.9.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b0cfa35270513b6d7c2020e6cd625628",
                    "sha256": "825fea6a029dea282de5f1174b24a19f6bdc8de7c31af96ff78b9e33bf8e7792"
                },
                "downloads": -1,
                "filename": "docserve-0.9.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "b0cfa35270513b6d7c2020e6cd625628",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">3.6.0",
                "size": 8536405,
                "upload_time": "2018-08-13T14:08:45",
                "url": "https://files.pythonhosted.org/packages/71/9b/e3a214bed8ef4c1b9d668c23db81742d3b85cb9ceb44f2f330a99b8ae4fa/docserve-0.9.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "fe7b871af4946f355dcc05ecf621b36c",
                    "sha256": "bc73e95b0ca34f5f4174c4e75fed9408e8003f92d8ad32db0c925000babf8366"
                },
                "downloads": -1,
                "filename": "docserve-0.9.1.tar.gz",
                "has_sig": false,
                "md5_digest": "fe7b871af4946f355dcc05ecf621b36c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">3.6.0",
                "size": 8530948,
                "upload_time": "2018-08-13T14:08:55",
                "url": "https://files.pythonhosted.org/packages/70/0a/126fc2e13064ec772b576e2ccb5904d5b696a99371f7dcedbabb23b389cd/docserve-0.9.1.tar.gz"
            }
        ],
        "0.9.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "067f797d0e197fd617e4204be3f7997c",
                    "sha256": "6b6a7b38ad48d2744680a239f4cee4a7287475cadc40be7940de43de9bbd4219"
                },
                "downloads": -1,
                "filename": "docserve-0.9.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "067f797d0e197fd617e4204be3f7997c",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6.0",
                "size": 8536411,
                "upload_time": "2018-08-13T14:17:27",
                "url": "https://files.pythonhosted.org/packages/72/73/6fe14e0b32653ef095969b7a90f44a35f184363aee0a2dc6adf257eb87cb/docserve-0.9.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "bd824917bc950ee0ea67713770e2c37f",
                    "sha256": "eb58666d68ef28cbe5812caa233e31a8b2d3afef8c570695d257b2363eee71b4"
                },
                "downloads": -1,
                "filename": "docserve-0.9.2.tar.gz",
                "has_sig": false,
                "md5_digest": "bd824917bc950ee0ea67713770e2c37f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6.0",
                "size": 8530960,
                "upload_time": "2018-08-13T14:17:33",
                "url": "https://files.pythonhosted.org/packages/df/4c/d938083ab125864d86332ba0babd2ef7f3fae461b6d0643e06cc613abdf3/docserve-0.9.2.tar.gz"
            }
        ],
        "0.9.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ecf31c752d1c32bac9e2ff3fe6b92c70",
                    "sha256": "fa86c8a82390c64bf59e142019d88f2fa34f808528ca54201b7d31aaf7a57995"
                },
                "downloads": -1,
                "filename": "docserve-0.9.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ecf31c752d1c32bac9e2ff3fe6b92c70",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6.0",
                "size": 8536810,
                "upload_time": "2018-08-13T16:26:33",
                "url": "https://files.pythonhosted.org/packages/d1/0c/d222e1f9cabdeea25f505943881f75050587e4ad05992d8a6d0a9a6eec50/docserve-0.9.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a019ea3022eb9e124e705951d428396d",
                    "sha256": "3fd2d9c7892b22acb12e765c97f9aac1e890999852c555694bfd6039fa78be4d"
                },
                "downloads": -1,
                "filename": "docserve-0.9.3.tar.gz",
                "has_sig": false,
                "md5_digest": "a019ea3022eb9e124e705951d428396d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6.0",
                "size": 8531499,
                "upload_time": "2018-08-13T16:26:41",
                "url": "https://files.pythonhosted.org/packages/bb/1e/603c7c59de22c99e223440118e3e432f2d8064d210f01afd7d69971275f0/docserve-0.9.3.tar.gz"
            }
        ],
        "0.9.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6bf1a42f88e5bb581891ecae9cdab012",
                    "sha256": "576f7f42275f43fa30e1b669a1f22eabc83e48e43b50e311a704de4b36699c56"
                },
                "downloads": -1,
                "filename": "docserve-0.9.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6bf1a42f88e5bb581891ecae9cdab012",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6.0",
                "size": 8540145,
                "upload_time": "2018-08-21T20:02:57",
                "url": "https://files.pythonhosted.org/packages/2f/03/d47023110bc53733c401ef722e8ff58d43b02581ad8b6c4bbeb65062bde9/docserve-0.9.4-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8eb48ea41a32a4b504a1b4a98489b772",
                    "sha256": "eaa5af40d8f428c051ed1b47e364822b3ba9f8879457f646c788bbf7fa51dbc9"
                },
                "downloads": -1,
                "filename": "docserve-0.9.4.tar.gz",
                "has_sig": false,
                "md5_digest": "8eb48ea41a32a4b504a1b4a98489b772",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6.0",
                "size": 8534567,
                "upload_time": "2018-08-21T20:03:05",
                "url": "https://files.pythonhosted.org/packages/8f/a2/d9da4a7b52f463e3984318ce8ac4b6f7783a995b3d35d8aeaa82bc002d45/docserve-0.9.4.tar.gz"
            }
        ],
        "0.9.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f1a745010b8296b088af5447a18b7e0",
                    "sha256": "a34b7def09a6b38a3088462c0f163c719f2b6300a1e289e8bc81827288cfc211"
                },
                "downloads": -1,
                "filename": "docserve-0.9.7-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8f1a745010b8296b088af5447a18b7e0",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6.0",
                "size": 10574795,
                "upload_time": "2018-08-24T18:17:58",
                "url": "https://files.pythonhosted.org/packages/da/c3/cd48e00c797d19655669303bfc7b92036d5454312af7cbc96f915ea3a600/docserve-0.9.7-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "61c127fd680cfa96708a4d3eb4fefec9",
                    "sha256": "a9cf98f846e0ee3aaf780aed225cec7a60fd8334b935f9816d2da1ef66e5c016"
                },
                "downloads": -1,
                "filename": "docserve-0.9.7.tar.gz",
                "has_sig": false,
                "md5_digest": "61c127fd680cfa96708a4d3eb4fefec9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6.0",
                "size": 10568112,
                "upload_time": "2018-08-24T18:18:05",
                "url": "https://files.pythonhosted.org/packages/8b/48/7d84f818ee7375a33a0f1bc6b1d520c1ba38c5966ee07dbe8188499cfd77/docserve-0.9.7.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8f1a745010b8296b088af5447a18b7e0",
                "sha256": "a34b7def09a6b38a3088462c0f163c719f2b6300a1e289e8bc81827288cfc211"
            },
            "downloads": -1,
            "filename": "docserve-0.9.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8f1a745010b8296b088af5447a18b7e0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6.0",
            "size": 10574795,
            "upload_time": "2018-08-24T18:17:58",
            "url": "https://files.pythonhosted.org/packages/da/c3/cd48e00c797d19655669303bfc7b92036d5454312af7cbc96f915ea3a600/docserve-0.9.7-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "61c127fd680cfa96708a4d3eb4fefec9",
                "sha256": "a9cf98f846e0ee3aaf780aed225cec7a60fd8334b935f9816d2da1ef66e5c016"
            },
            "downloads": -1,
            "filename": "docserve-0.9.7.tar.gz",
            "has_sig": false,
            "md5_digest": "61c127fd680cfa96708a4d3eb4fefec9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6.0",
            "size": 10568112,
            "upload_time": "2018-08-24T18:18:05",
            "url": "https://files.pythonhosted.org/packages/8b/48/7d84f818ee7375a33a0f1bc6b1d520c1ba38c5966ee07dbe8188499cfd77/docserve-0.9.7.tar.gz"
        }
    ]
}