.. 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