.. image:: https://github.com/MacHu-GWU/func_args-project/workflows/CI/badge.svg
:target: https://github.com/MacHu-GWU/func_args-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/func_args-project/branch/main/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/func_args-project
.. image:: https://img.shields.io/pypi/v/func_args.svg
:target: https://pypi.python.org/pypi/func_args
.. image:: https://img.shields.io/pypi/l/func_args.svg
:target: https://pypi.python.org/pypi/func_args
.. image:: https://img.shields.io/pypi/pyversions/func_args.svg
:target: https://pypi.python.org/pypi/func_args
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/func_args-project
------
.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg
:target: https://func_args.readthedocs.io/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Install-blue.svg
:target: `install`_
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/func_args-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/func_args-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/func_args-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/func_args#files
Welcome to ``func_args`` Documentation
==============================================================================
``func_args`` is a library that can help you create a wrapper function with key word arguments, type hint on top of an existing third party function with ugly API design. `See example <https://github.com/MacHu-GWU/func_args-project/blob/main/examples/example.ipynb>`_.
.. _install:
Install
------------------------------------------------------------------------------
``func_args`` is released on PyPI, so all you need is:
.. code-block:: console
$ pip install func_args
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade func_args
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/func_args-project",
"name": "func-args",
"maintainer": "Unknown",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/04/19/bb084bcac2442ff3a764e59b08ea60ac7840cfc674f9074751caf21a0498/func_args-0.1.1.tar.gz",
"platform": "Windows",
"description": "\n.. image:: https://github.com/MacHu-GWU/func_args-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/func_args-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/func_args-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/func_args-project\n\n.. image:: https://img.shields.io/pypi/v/func_args.svg\n :target: https://pypi.python.org/pypi/func_args\n\n.. image:: https://img.shields.io/pypi/l/func_args.svg\n :target: https://pypi.python.org/pypi/func_args\n\n.. image:: https://img.shields.io/pypi/pyversions/func_args.svg\n :target: https://pypi.python.org/pypi/func_args\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/func_args-project\n\n------\n\n.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg\n :target: https://func_args.readthedocs.io/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/func_args-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/func_args-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/func_args-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/func_args#files\n\n\nWelcome to ``func_args`` Documentation\n==============================================================================\n\n``func_args`` is a library that can help you create a wrapper function with key word arguments, type hint on top of an existing third party function with ugly API design. `See example <https://github.com/MacHu-GWU/func_args-project/blob/main/examples/example.ipynb>`_.\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``func_args`` is released on PyPI, so all you need is:\n\n.. code-block:: console\n\n $ pip install func_args\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade func_args\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Bring in sentinel ``NOTHING`` into your Python function arguments.",
"version": "0.1.1",
"project_urls": {
"Download": "https://pypi.python.org/pypi/func_args/0.1.1#downloads",
"Homepage": "https://github.com/MacHu-GWU/func_args-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27c67c57a76acd4f52aafaa47c7884b2c7344dac6696591efcce593d4de29474",
"md5": "d4b33350321362f52a5187976b8c42fd",
"sha256": "8640ffee0ae20dafa775bd012ced8b20835200bdb0e5847b9ef004acbf553993"
},
"downloads": -1,
"filename": "func_args-0.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4b33350321362f52a5187976b8c42fd",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 5549,
"upload_time": "2023-02-16T14:36:33",
"upload_time_iso_8601": "2023-02-16T14:36:33.618280Z",
"url": "https://files.pythonhosted.org/packages/27/c6/7c57a76acd4f52aafaa47c7884b2c7344dac6696591efcce593d4de29474/func_args-0.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0419bb084bcac2442ff3a764e59b08ea60ac7840cfc674f9074751caf21a0498",
"md5": "99ea91351a9bc5470766bd53e4c8906b",
"sha256": "4815248811505c6bb75fbc03059448323a4b7e58fa6fa17b525c1dae75a7565b"
},
"downloads": -1,
"filename": "func_args-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "99ea91351a9bc5470766bd53e4c8906b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7065,
"upload_time": "2023-02-16T14:36:35",
"upload_time_iso_8601": "2023-02-16T14:36:35.659946Z",
"url": "https://files.pythonhosted.org/packages/04/19/bb084bcac2442ff3a764e59b08ea60ac7840cfc674f9074751caf21a0498/func_args-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-16 14:36:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "func_args-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "func-args"
}