{ "info": { "author": "tommyod", "author_email": "tod001@uib.no", "bugtrack_url": null, "classifiers": [ "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3 :: Only" ], "description": "# \n[![Build Status](https://api.travis-ci.com/tommyod/treedoc.svg?branch=master)](https://travis-ci.com/tommyod/treedoc) [![PyPI version](https://badge.fury.io/py/treedoc.svg)](https://pypi.org/project/treedoc/) [![Downloads](https://pepy.tech/badge/treedoc)](https://pepy.tech/project/treedoc) [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nMinimalistic Python documentation for dendrophiles.\n\ntreedoc prints minimalistic Python documentation in a tree structure,\naiming to hit the sweet spot between detailed information about\na single object and superficial information about object attributes.\n\ntreedoc is great for:\n- Getting an overview of a package without endlessly scrolling through a website.\n- Searching through documentation.\n- Printing essential information about different Python objects. \n\n## Installation\n\nInstall from [Python Package Index](https://pypi.org/project/treedoc/) (PyPI) using `pip install treedoc`.\n\n## Usage\n\ntreedoc can be used directly through the command-line interface,\nor interactively in a Python shell or Jupyter notebook. For more information\nabout arguments, see `treedoc --help` or `help(treedoc)`.\n\n### Command-line interface\n\n![Example 1 - See the GitHub repo](https://github.com/tommyod/treedoc/blob/master/branding/examples/example_list.gif)\n\n![Example 2 - See the GitHub repo](https://github.com/tommyod/treedoc/blob/master/branding/examples/example_collectionsabc.gif)\n\n![Example 3 - See the GitHub repo](https://github.com/tommyod/treedoc/blob/master/branding/examples/example_pandas_grep.gif)\n\n\n## Python shell and notebooks\n\ntreedoc can be imported and used just like any other package, e.g. in an\ninteractive Python interpreter session or a Jupyter notebook. \n\n### Interpreter\n![Example 4 - See the GitHub repo](https://github.com/tommyod/treedoc/blob/master/branding/examples/example_python_list.gif)\n\n### Jupyter notebook\n![Example 5 - See the GitHub repo](https://github.com/tommyod/treedoc/blob/master/branding/examples/example_jupyter_list.gif)\n\n## Contributing\n\nContributions are welcome.\nIf you wish to work on a problem, please create a [pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/) to get feedback.\nWe aim for:\n\n- Zero dependencies, but dependencies for testing are ok.\n- Idiomatic, clean Python code. Readability matters.\n- Thorough testing and code formatting, see `.travis.yml` for commands run by continuous integration.\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/tommyod/treedoc", "keywords": "documentation, utility", "license": "MIT", "maintainer": "tommyod, smu095, glemvik", "maintainer_email": "treedoc.dev@gmail.com", "name": "treedoc", "package_url": "https://pypi.org/project/treedoc/", "platform": "", "project_url": "https://pypi.org/project/treedoc/", "project_urls": { "Homepage": "https://github.com/tommyod/treedoc" }, "release_url": "https://pypi.org/project/treedoc/1.0.0/", "requires_dist": null, "requires_python": ">=3.6", "summary": "Minimalistic Python documentation for dendrophiles.", "version": "1.0.0" }, "last_serial": 5915944, "releases": { "0.4.0": [ { "comment_text": "", "digests": { "md5": "bf19d15abe3655164db77a69266d8435", "sha256": "c1dc058e8b2d21cba187e464d570d555dc3b140d5c5121ae803f4e5c2a21fa65" }, "downloads": -1, "filename": "treedoc-0.4.0-py3-none-any.whl", "has_sig": false, "md5_digest": "bf19d15abe3655164db77a69266d8435", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 19814, "upload_time": "2019-07-18T18:37:51", "url": "https://files.pythonhosted.org/packages/4e/a2/25630f1f557b74edf86e7b9b3980240c1223b001d99fc06e7d2d1c5c0772/treedoc-0.4.0-py3-none-any.whl" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "6621b17fd42d324501184e1cb7e8cc68", "sha256": "3e95e87a1f6dad34a3912e4c09b552097d8cff99dca570090fec51e6cf078b3e" }, "downloads": -1, "filename": "treedoc-0.4.1.tar.gz", "has_sig": false, "md5_digest": "6621b17fd42d324501184e1cb7e8cc68", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 1173349, "upload_time": "2019-07-18T18:41:10", "url": "https://files.pythonhosted.org/packages/b4/0b/6b49f64854d2da80f85d115ee99ca17cc643aaf3b32718c393bbb612731f/treedoc-0.4.1.tar.gz" } ], "0.4.2": [ { "comment_text": "", "digests": { "md5": "0d82cf260fdaf06abd57d6ac4049d912", "sha256": "c72f196ad0e071bd79c7d6d7f362ae770318829c3a5bf379b1b5574d5430900c" }, "downloads": -1, "filename": "treedoc-0.4.2.tar.gz", "has_sig": false, "md5_digest": "0d82cf260fdaf06abd57d6ac4049d912", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 1173411, "upload_time": "2019-07-26T09:24:23", "url": "https://files.pythonhosted.org/packages/e0/37/1b6543d07781912924c4a879cf5e818264b5036723e775b619bf8de70eac/treedoc-0.4.2.tar.gz" } ], "0.4.3": [ { "comment_text": "", "digests": { "md5": "d97f7008be3b885e16268a5f5d9a3422", "sha256": "90043fa10e400ade94b54db2f518f6f89c55c4662e370ed236d4d50116804679" }, "downloads": -1, "filename": "treedoc-0.4.3.tar.gz", "has_sig": false, "md5_digest": "d97f7008be3b885e16268a5f5d9a3422", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 1173402, "upload_time": "2019-07-26T09:26:38", "url": "https://files.pythonhosted.org/packages/3c/3f/df44349e67525bb02fa928f48477a7ea00d2dd76708eda0b1c6a65193344/treedoc-0.4.3.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "d841f7614c7a60338fb1689516484558", "sha256": "ce2a121ce05aa90893d13227a0764d2a05e38e0e79fbf1fb9b05da4c03b26efb" }, "downloads": -1, "filename": "treedoc-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d841f7614c7a60338fb1689516484558", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 20385, "upload_time": "2019-07-26T20:06:44", "url": "https://files.pythonhosted.org/packages/18/f0/544138651afaa842db0aec64cf94d54521e1b209617ee6d07181659ca590/treedoc-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9222c4978534bd10fa67b13ce47442f4", "sha256": "e462614ee6529b8fddea1d3d745a376021ca5bcbb985828b9b6be15e57bd14dd" }, "downloads": -1, "filename": "treedoc-1.0.0.tar.gz", "has_sig": false, "md5_digest": "9222c4978534bd10fa67b13ce47442f4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 17631, "upload_time": "2019-07-26T20:06:45", "url": "https://files.pythonhosted.org/packages/65/f4/b32de50f62b700fc826f4bbebb5c08081f41c7e045109172d463588aa825/treedoc-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d841f7614c7a60338fb1689516484558", "sha256": "ce2a121ce05aa90893d13227a0764d2a05e38e0e79fbf1fb9b05da4c03b26efb" }, "downloads": -1, "filename": "treedoc-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d841f7614c7a60338fb1689516484558", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 20385, "upload_time": "2019-07-26T20:06:44", "url": "https://files.pythonhosted.org/packages/18/f0/544138651afaa842db0aec64cf94d54521e1b209617ee6d07181659ca590/treedoc-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9222c4978534bd10fa67b13ce47442f4", "sha256": "e462614ee6529b8fddea1d3d745a376021ca5bcbb985828b9b6be15e57bd14dd" }, "downloads": -1, "filename": "treedoc-1.0.0.tar.gz", "has_sig": false, "md5_digest": "9222c4978534bd10fa67b13ce47442f4", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 17631, "upload_time": "2019-07-26T20:06:45", "url": "https://files.pythonhosted.org/packages/65/f4/b32de50f62b700fc826f4bbebb5c08081f41c7e045109172d463588aa825/treedoc-1.0.0.tar.gz" } ] }