Metadata-Version: 2.1
Name: func_args
Version: 0.1.1
Summary: Bring in sentinel ``NOTHING`` into your Python function arguments.
Home-page: https://github.com/MacHu-GWU/func_args-project
Download-URL: https://pypi.python.org/pypi/func_args/0.1.1#downloads
Author: Sanhe Hu
Author-email: husanhe@gmail.com
Maintainer: Unknown
License: MIT
Platform: Windows
Platform: MacOS
Platform: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Provides-Extra: tests
Provides-Extra: docs
License-File: LICENSE.txt
License-File: AUTHORS.rst


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