{ "info": { "author": "Oliver Ruebel", "author_email": "oruebel@lbl.gov", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Documentation :: Sphinx" ], "description": "===========================\nNWB Documentation Utilities\n===========================\n\n*This project is under active development. Its content, API and behavior may change at any time. We mean it.*\n\n.. image:: https://img.shields.io/pypi/l/nwb-docutils.svg\n :target: https://github.com/NeurodataWithoutBorders/nwb-docutils/blob/master/license.txt\n :alt: PyPI - License\n\n.. image:: https://img.shields.io/pypi/v/nwb-docutils.svg\n :target: https://pypi.org/project/nwb-docutils/\n :alt: PyPI\n\n.. image:: https://dev.azure.com/NeurodataWithoutBorders/nwb-docutils/_apis/build/status/NeurodataWithoutBorders.nwb-docutils?branchName=master\n :target: https://dev.azure.com/NeurodataWithoutBorders/nwb-docutils/_build/latest?definitionId=1&branchName=master\n :alt: Build Status\n\nOverview\n--------\n\nThis project is a collection of CLIs, scripts and modules useful to generate the NWB documentation.\n\nUsing nwb-docutils to generate documentation for an extension: http://pynwb.readthedocs.io/en/latest/extensions.html#documenting-extensions\n\n\nInstallation\n------------\n\n::\n\n pip install nwb-docutils\n\n\n\nAvailable Tools\n---------------\n\n* ``nwb_generate_format_docs``: Generate figures and RST documents from the NWB YAML specification for the\n format specification documentation.\n\n* ``nwb_init_sphinx_extension_doc``: Create format specification SPHINX documentation for an NWB extension.\n\n* ``nwb_gallery_prototype``\n\n\nAvailable Modules\n-----------------\n\n* ``nwb_docutils/doctools/*``: This package contains modules used to generate figures of the hierarchies of\n NWB-N files and specifications as well as to help with the programmatic generation of reStructuredText (RST)\n documents.\n\n\nAvailable Notebooks\n-------------------\n\n* `compare-hdf5-files.ipynb `_: This\n notebook illustrates how to compare hdf5 files.\n\n\nHistory\n-------\n\nnwb-utils was initially a sub-directory of the nwb-schema project. Corresponding history was extracted during\nthe `4th NWB Hackathon `_ into a\ndedicated *pip-installable* project to facilitate its use by both core NWB documentation projects and various\nNWB extensions.\n\n\nmaintainers: how to make a release ?\n------------------------------------\n\n1. Configure ``~/.pypirc`` as described `here `_.\n\n\n2. Make sure the cli and module work as expected.\n\n\n3. List all tags sorted by version\n\n ::\n\n $ git fetch --tags && \\\n git tag -l | sort -V\n\n\n4. Choose the next release version number::\n\n release=\"X.Y.Z\"\n\n\n5. Tag the release. Requires a GPG key with signatures\n\n ::\n\n git tag -s -m \"nwb-docutils ${release}\" ${release} origin/master\n\n And push\n\n ::\n\n git push origin ${release}\n\n\n6. Create the source tarball and binary wheels\n\n ::\n\n rm -rf dist/\n python setup.py sdist bdist_wheel\n\n\n7. Upload the packages to the testing PyPI instance\n\n ::\n\n twine upload --sign -r pypitest dist/*\n\n\n8. Check the `PyPI testing package page `_.\n\n\n9. Upload the packages to the PyPI instance::\n\n twine upload --sign dist/*\n\n\n10. Check the `PyPI package page `_.\n\n\n11. Create a virtual env, and make sure the package can be installed\n\n ::\n\n mkvirtualenv test-nwb-docutils-install\n pip install nwb-docutils\n\n\n12. Cleanup\n\n ::\n\n deactivate\n rmvirtualenv test-nwb-docutils-install\n\n\n", "description_content_type": "text/x-rst; charset=UTF-8", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/NeurodataWithoutBorders/nwb-docutils", "keywords": "Neuroscience python HDF HDF5 cross-platform open-data data-format open-source open-science reproducible-research PyNWB NWB NWB:N NeurodataWithoutBorders", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "nwb-docutils", "package_url": "https://pypi.org/project/nwb-docutils/", "platform": "", "project_url": "https://pypi.org/project/nwb-docutils/", "project_urls": { "Homepage": "https://github.com/NeurodataWithoutBorders/nwb-docutils" }, "release_url": "https://pypi.org/project/nwb-docutils/0.3.1/", "requires_dist": [ "matplotlib", "networkx", "pynwb", "hdmf", "pillow", "sphinx (==1.6.5)", "sphinx-gallery", "sphinx-rtd-theme" ], "requires_python": "", "summary": "Collection of CLIs, scripts and modules useful to generate the NWB documentation", "version": "0.3.1" }, "last_serial": 5286941, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "7752cbe1a9546181c2777b00c6dab596", "sha256": "699eafeaa09844eef28599befce32afa0cd8e7b344c8aad79d9d539266b0c7cc" }, "downloads": -1, "filename": "nwb_docutils-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7752cbe1a9546181c2777b00c6dab596", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1597980, "upload_time": "2018-04-06T07:23:18", "url": "https://files.pythonhosted.org/packages/e5/51/6992b51edaba397a1110db72c89aab987661883512ed74999f2b705d5897/nwb_docutils-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "26f15823ceb1f1915b67930a59d2c7a8", "sha256": "941ecd28fda50cd8b307add65d93104afeb4608aaa55ac93071d60c9e2129710" }, "downloads": -1, "filename": "nwb_docutils-0.1.0.tar.gz", "has_sig": false, "md5_digest": "26f15823ceb1f1915b67930a59d2c7a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1611854, "upload_time": "2018-04-06T07:23:21", "url": "https://files.pythonhosted.org/packages/f8/ab/64d5688e3b73f39858c5bb443f3948582f300fbef28160dd875b8fe369ac/nwb_docutils-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "d2437ed05d7af23771e7d949fc5e6cc7", "sha256": "8a8e6554df3e50e2203d6cd4210f1b35668fad674ab533e0c0dac677094aac31" }, "downloads": -1, "filename": "nwb_docutils-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d2437ed05d7af23771e7d949fc5e6cc7", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1596269, "upload_time": "2018-04-07T00:00:56", "url": "https://files.pythonhosted.org/packages/0c/ba/b334d08da188b3eecc8825bedfa0c6376a666cceeffb2dc59058a2de2cbe/nwb_docutils-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "199ff1766a657ce3588cc326368cf49c", "sha256": "9a668d8ffd3943809e20bd31ae34666d813d1a0b29062a0ba58a450492f7eaf5" }, "downloads": -1, "filename": "nwb_docutils-0.2.0.tar.gz", "has_sig": false, "md5_digest": "199ff1766a657ce3588cc326368cf49c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1613275, "upload_time": "2018-04-07T00:00:59", "url": "https://files.pythonhosted.org/packages/5a/0a/a24cbe06965a2d62cb19d69defbe55fa8b482f2aa34c9757e1bf8feb3a71/nwb_docutils-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "1aa652946aefd4b43d0984fb9662e59e", "sha256": "7f10b030348e2b5d50d234bb4cc791813b1bf9e12594b1182fa38e596b94b59e" }, "downloads": -1, "filename": "nwb_docutils-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1aa652946aefd4b43d0984fb9662e59e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1598283, "upload_time": "2018-04-11T23:26:49", "url": "https://files.pythonhosted.org/packages/d6/3d/4d48f20fff5e720efda2e1436471e110b9564b73b66084bbcbfe48996508/nwb_docutils-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "17f4c575abf7e5db9aa7caa36a165761", "sha256": "96687c019d1860f26c5d9fef6bc5b321f4cbb9d85b67c51b52744a41dc5bb594" }, "downloads": -1, "filename": "nwb_docutils-0.2.1.tar.gz", "has_sig": false, "md5_digest": "17f4c575abf7e5db9aa7caa36a165761", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1612481, "upload_time": "2018-04-11T23:26:51", "url": "https://files.pythonhosted.org/packages/33/11/29eff818237eebab41b73b56bd260419524ce10d2f1f1f7c09b38dbac295/nwb_docutils-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "4ea8f5b86466044e34abb02191e991f6", "sha256": "2d189075a5591bf3b77ea4c421824a38dc96c96152ae946f9e55c18d9690c461" }, "downloads": -1, "filename": "nwb_docutils-0.3.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "4ea8f5b86466044e34abb02191e991f6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1601974, "upload_time": "2019-05-18T04:07:31", "url": "https://files.pythonhosted.org/packages/ba/d2/173749c0c3a1fe46dcab037dd310ff2d326d9d8d8f5fc3d71d79bbf55bc7/nwb_docutils-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d40862c6b7e22bd2cf78ae323153eee9", "sha256": "b00c123b8ded022130a01f9462f53e523921736ed8f598d18f6a8697bc2784be" }, "downloads": -1, "filename": "nwb_docutils-0.3.0.tar.gz", "has_sig": true, "md5_digest": "d40862c6b7e22bd2cf78ae323153eee9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1617896, "upload_time": "2019-05-18T04:07:40", "url": "https://files.pythonhosted.org/packages/56/67/2679ae1f4008daf71c9f97fbaa9ab77e5d2360c0d409b8765ee1237df420/nwb_docutils-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "276ea369adee916a8a339881a02e83e3", "sha256": "cfb1068dfefdf56a99eeca1a2d6246b01f941a7a2243b1af1856b7d8d22e2025" }, "downloads": -1, "filename": "nwb_docutils-0.3.1-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "276ea369adee916a8a339881a02e83e3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1601933, "upload_time": "2019-05-19T00:20:56", "url": "https://files.pythonhosted.org/packages/11/58/901cef9624ff8ad1b93e37b099681aae14ceaea9d60ec7feebc0902526cd/nwb_docutils-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "652ecddf788f114405f0fc1d7bc010ec", "sha256": "97042b435c3ae4e6be960bdb753fb573814a1b6f17d1b992c6342a50d1fd8ef0" }, "downloads": -1, "filename": "nwb_docutils-0.3.1.tar.gz", "has_sig": true, "md5_digest": "652ecddf788f114405f0fc1d7bc010ec", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1617928, "upload_time": "2019-05-19T00:21:05", "url": "https://files.pythonhosted.org/packages/03/5d/78e5bdda09d3c6bfd80ab7c2607c6d57e32bf46b56da516bbad867538bdf/nwb_docutils-0.3.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "276ea369adee916a8a339881a02e83e3", "sha256": "cfb1068dfefdf56a99eeca1a2d6246b01f941a7a2243b1af1856b7d8d22e2025" }, "downloads": -1, "filename": "nwb_docutils-0.3.1-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "276ea369adee916a8a339881a02e83e3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1601933, "upload_time": "2019-05-19T00:20:56", "url": "https://files.pythonhosted.org/packages/11/58/901cef9624ff8ad1b93e37b099681aae14ceaea9d60ec7feebc0902526cd/nwb_docutils-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "652ecddf788f114405f0fc1d7bc010ec", "sha256": "97042b435c3ae4e6be960bdb753fb573814a1b6f17d1b992c6342a50d1fd8ef0" }, "downloads": -1, "filename": "nwb_docutils-0.3.1.tar.gz", "has_sig": true, "md5_digest": "652ecddf788f114405f0fc1d7bc010ec", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1617928, "upload_time": "2019-05-19T00:21:05", "url": "https://files.pythonhosted.org/packages/03/5d/78e5bdda09d3c6bfd80ab7c2607c6d57e32bf46b56da516bbad867538bdf/nwb_docutils-0.3.1.tar.gz" } ] }