{"id":25177898,"url":"https://github.com/axelgard/inkpot","last_synced_at":"2025-05-07T02:41:50.149Z","repository":{"id":38318446,"uuid":"381980064","full_name":"AxelGard/inkpot","owner":"AxelGard","description":"a simple library for generating documentation from docstrings","archived":false,"fork":false,"pushed_at":"2024-06-11T20:18:05.000Z","size":81,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T12:17:12.826Z","etag":null,"topics":["docs-generator","docstrings","documentation","markdown","pip","python","python-library","python-package","python3","simple","tool"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/inkpot/","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/AxelGard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-01T09:30:51.000Z","updated_at":"2024-06-12T16:07:32.000Z","dependencies_parsed_at":"2024-06-11T23:05:44.373Z","dependency_job_id":null,"html_url":"https://github.com/AxelGard/inkpot","commit_stats":{"total_commits":61,"total_committers":3,"mean_commits":"20.333333333333332","dds":0.3114754098360656,"last_synced_commit":"5aae230eae003c19f3451edd66068eb7373b68cc"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AxelGard%2Finkpot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AxelGard%2Finkpot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AxelGard%2Finkpot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AxelGard%2Finkpot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AxelGard","download_url":"https://codeload.github.com/AxelGard/inkpot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252802570,"owners_count":21806527,"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":["docs-generator","docstrings","documentation","markdown","pip","python","python-library","python-package","python3","simple","tool"],"created_at":"2025-02-09T14:49:54.464Z","updated_at":"2025-05-07T02:41:50.094Z","avatar_url":"https://github.com/AxelGard.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# inkpot\nA small simple library for generating documentation from docstrings\n\ninkpot is available on [pip](https://pypi.org/project/inkpot/). **Please give it a star if you like it!**\n\n\u003cimg src=\"https://cdn.pixabay.com/photo/2014/04/05/12/20/ink-316909_960_720.jpg\" alt=\"drawing\" width=\"300\"/\u003e\n\n![GitHub stars](https://img.shields.io/github/stars/AxelGard/inkpot?style=social)\n![GitHub forks](https://img.shields.io/github/forks/AxelGard/inkpot?style=social)\n[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/Axel_Gard)\n\n![GitHub](https://img.shields.io/github/license/AxelGard/inkpot?style=plastic)\n![PyPI](https://img.shields.io/pypi/v/inkpot)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/inkpot)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/inkpot)\n\nTo know more about way this project was started, checkout this **[blog post](https://axelgard.github.io/blog/inkpot/2021/07/01/inkpot-init.html)**.\n\n## Installation\n```bash\npip install inkpot\n```\n\n## Usage\nsingle file\n```bash\npython3 -m inkpot myfile.py\n```\nor directory\n```bash\npython3 -m inkpot myproject/\n```\noutput to a file (also works with directories)\n```bash\npython3 -m inkpot myfile.py \u003e doc.md\npython3 -m inkpot myproject/ \u003e doc.md\n```\n\nMore functionality and better formatting might be added.\n\n## Example\n\nOn the [wiki](https://github.com/AxelGard/inkpot/wiki/inkpot-src-docs) you can se the result of running inkpot on the inkpot source code.\n\nHere is a small example from the test files. \n\nPython file `tests/.ex/add.py`\n```python\ndef add(a,b):\n    \"\"\" add to objects \"\"\"\n    return a + b\n\n```\n\n```bash\npython3 -m inkpot tests/.ex/add.py\n```\nreturns markdown\n```\n# tests/.ex/add.py\n## tests/.ex/add.py\n**def add(a, b)** \\\n`add to objects `\n```\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details\n\n\n## Acknowledgement \n\nA special thanks to: \n\n* [Astunparse](https://pypi.org/project/astunparse/), which is used in inkpot to unparse python files\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxelgard%2Finkpot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faxelgard%2Finkpot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxelgard%2Finkpot/lists"}