{"id":16199969,"url":"https://github.com/chilipp/funcargparse","last_synced_at":"2025-07-15T18:33:16.131Z","repository":{"id":57432592,"uuid":"72748303","full_name":"Chilipp/funcargparse","owner":"Chilipp","description":"Create an argparse.ArgumentParser from function docstrings","archived":false,"fork":false,"pushed_at":"2021-06-28T18:52:54.000Z","size":61,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-28T08:55:33.827Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Chilipp.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-03T13:31:56.000Z","updated_at":"2021-07-04T15:03:16.000Z","dependencies_parsed_at":"2022-09-19T08:10:52.019Z","dependency_job_id":null,"html_url":"https://github.com/Chilipp/funcargparse","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chilipp%2Ffuncargparse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chilipp%2Ffuncargparse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chilipp%2Ffuncargparse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Chilipp%2Ffuncargparse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Chilipp","download_url":"https://codeload.github.com/Chilipp/funcargparse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243971180,"owners_count":20376784,"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":[],"created_at":"2024-10-10T09:28:50.999Z","updated_at":"2025-03-19T05:30:54.047Z","avatar_url":"https://github.com/Chilipp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==========================================================\nCreate an argparse.ArgumentParser from function docstrings\n==========================================================\n\n.. start-badges\n\n.. list-table::\n    :stub-columns: 1\n    :widths: 10 90\n\n    * - docs\n      - |docs|\n    * - tests\n      - |github-action| |requires| |codecov|\n    * - package\n      - |version| |supported-versions| |supported-implementations|\n\n.. |docs| image:: http://readthedocs.org/projects/funcargparse/badge/?version=latest\n    :alt: Documentation Status\n    :target: http://funcargparse.readthedocs.io/en/latest/?badge=latest\n\n.. |github-action| image:: https://github.com/Chilipp/funcargparse/workflows/Tests/badge.svg\n    :alt: Tests\n    :target: https://github.com/Chilipp/funcargparse/actions?query=workflow%3A%22Tests%22\n\n.. |codecov| image:: https://codecov.io/gh/Chilipp/funcargparse/branch/master/graph/badge.svg?token=UX1B5ocBbP\n    :alt: Codecov\n    :target: https://codecov.io/gh/Chilipp/funcargparse\n\n.. |requires| image:: https://requires.io/github/Chilipp/funcargparse/requirements.svg?branch=master\n    :alt: Requirements Status\n    :target: https://requires.io/github/Chilipp/funcargparse/requirements/?branch=master\n\n.. |version| image:: https://img.shields.io/pypi/v/funcargparse.svg?style=flat\n    :alt: PyPI Package latest release\n    :target: https://pypi.python.org/pypi/funcargparse\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/funcargparse.svg?style=flat\n    :alt: Supported versions\n    :target: https://pypi.python.org/pypi/funcargparse\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/funcargparse.svg?style=flat\n    :alt: Supported implementations\n    :target: https://pypi.python.org/pypi/funcargparse\n\n.. end-badges\n\nWelcome! Additionally to the default behaviour of the\n``argparse.ArgumentParser``, the ``funcargparse.FuncArgParser`` in this\npackage allows you to\n\n1. automatically create a parser entirely from the docstring of a function,\n   including the `help`, `metavar`, `action`, `type` and other parameters\n2. Let's you chain subparsers\n\nThere are a lot of argparse extensions out there, but through the use of the\ndocrep_ package, this package can extract much more information to automate\nthe creation of the command line utility.\n\nSee the documentation_ for more information.\n\n.. _docrep: http://docrep.readthedocs.io/en/latest/\n.. _documentation: http://funcargparse.readthedocs.io/en/latest/\n\n\nInstallation\n============\nSimply install it via ``pip``::\n\n    $ pip install funcargparse\n\nOr you install it via::\n\n    $ python setup.py install\n\nfrom the `source on GitHub`_.\n\n\n.. _source on GitHub: https://github.com/Chilipp/funcargparse\n\n\nRequirements\n============\nThe package only requires the docrep_ package which we use under the hood to\nextract the necessary parts from the docstrings.\n\nThe package has been tested for python 2.7 and 3.5.\n\n.. _docrep: http://docrep.readthedocs.io/en/latest/\n\n\nDisclaimer\n==========\nCopyright 2016-2019, Philipp S. Sommer\n\nCopyright 2020-2021, Helmholtz-Zentrum Hereon\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchilipp%2Ffuncargparse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchilipp%2Ffuncargparse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchilipp%2Ffuncargparse/lists"}