Metadata-Version: 2.1
Name: arglabels
Version: 0.0.2
Summary: A simple decorator to enable Swift-like argument labels for functions.
Home-page: https://github.com/michael-harms/arglabels
Author: Michael Harms
Author-email: michaelharms95@icloud.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# arglabels

A simple decorator to enable Swift-like argument labels for functions.

It re-labels certain keyword arguments, so that your function parameters can have an external and an internal name like [argument labels and parameter names](https://docs.swift.org/swift-book/LanguageGuide/Functions.html#ID166) in Swift.

## Installation

Install from PyPI with:

```
pip install arglabels
```

## Usage

If you have a function like the following:

```python
def invite(name, activity):
    return f"Hey {name}! Would you like to go {activity}?"
```

When calling that function it would be nice to have a syntax that almost reads like plain english, for example:

```python
invite("Alex", to_go="fishing")
```

You can achieve this with the arglabels decorator, by using it on the function definition like so:

```python
import arglabels

@arglabels(activity="to_go")
def invite(name, activity):
    return f"Hey {name}! Would you like to go {activity}?"
```


