{"id":19669168,"url":"https://github.com/tommyod/treedoc","last_synced_at":"2025-04-29T00:30:49.998Z","repository":{"id":56195175,"uuid":"181711079","full_name":"tommyod/treedoc","owner":"tommyod","description":"Minimalistic Python documentation for dendrophiles.","archived":false,"fork":false,"pushed_at":"2023-02-20T06:00:23.000Z","size":1254,"stargazers_count":10,"open_issues_count":3,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-03T09:21:36.063Z","etag":null,"topics":["cli","docs","documentation","python","terminal"],"latest_commit_sha":null,"homepage":"https://github.com/tommyod/treedoc","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tommyod.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-16T14:54:28.000Z","updated_at":"2023-02-20T06:00:23.000Z","dependencies_parsed_at":"2022-08-15T14:30:55.687Z","dependency_job_id":null,"html_url":"https://github.com/tommyod/treedoc","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tommyod%2Ftreedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tommyod%2Ftreedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tommyod%2Ftreedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tommyod%2Ftreedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tommyod","download_url":"https://codeload.github.com/tommyod/treedoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250771628,"owners_count":21484591,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","docs","documentation","python","terminal"],"created_at":"2024-11-11T16:39:15.482Z","updated_at":"2025-04-29T00:30:49.639Z","avatar_url":"https://github.com/tommyod.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cimg src=\"https://raw.githubusercontent.com/tommyod/treedoc/master/branding/icons/treedoc_white_rounded.png\" height=\"60\"\u003e\n![Build Status](https://github.com/tommyod/treedoc/workflows/Python%20CI/badge.svg?branch=master) [![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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftommyod%2Ftreedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftommyod%2Ftreedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftommyod%2Ftreedoc/lists"}