Skip to main content

The easy way to write your own Pandas flavor.

Project description


# Pandas Flavor
**The easy way to write your own flavor of Pandas**

Pandas added an new (simple) API to register accessors with Pandas objects.
This package adds support for registering methods as well.

*What does this mean?*

It's super easy to custom functionality to Pandas DataFrames and Series.

Import this package. Write a simple python function. Register the function using one of the following decorators.

*Why?*

Pandas is super handy. Its general purpose is to be a "flexible and powerful data analysis/manipulation library".

**Pandas Flavor** allows you to tailor Pandas to specific fields or use cases.

Maybe you want to add new write methods to the Pandas DataFrame? Maybe you want custom plot functionality? Maybe something else?

## Register accessors

Accessors (in pandas) are objects attached to a attribute on the Pandas DataFrame/Series
that provide extra, specific functionality. For example, `pandas.DataFrame.plot` is an
accessor that provides plotting functionality.

Add an accessor by registering the function with the following decorator
and passing the decorator an accessor name.

```python
import pandas as pd
import pandas_flavor as pf

@pf.register_dataframe_accessor('my_flavor')
def is_cool(df):
"""Is my accessor cool?"""
return True

# DataFrame.
df = DataFrame()

# Access this functionality
df.my_flavor.is_cool()
# Returns True
True
```

To see this in action, check out [pdvega](https://github.com/jakevdp/pdvega)! this
library adds a new plotting accessor for making Vega plots from pandas data.

## Register methods

Using this package, you can attach functions directly to Pandas objects. No
intermediate accessor is needed.

```python
import pandas as pd
import pandas_flavor as pf

@pf.register_dataframe_method
def is_cool(df):
"""Is my dataframe cool?"""
return True

# DataFrame.
df = DataFrame()

# Access this functionality
df.is_cool()
# Returns True
True
```

To see in action, check out [PhyloPandas](https://github.com/Zsailer/phylopandas).
This library adds extra `to_` methods for writing DataFrames to various biological
sequencing file formats.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pandas_flavor-0.1.1.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

pandas_flavor-0.1.1-py2.py3-none-any.whl (5.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pandas_flavor-0.1.1.tar.gz.

File metadata

File hashes

Hashes for pandas_flavor-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f35f3111b99405e43a2fd9e1552e5d855b151b23b49a15f025b318bfbc8b3761
MD5 1cbdf8017e5e0346c57d06efb15aecca
BLAKE2b-256 1515f65df779b159a95e7d56224e2577803c20f4e690767e8aa910e2d0de5b7b

See more details on using hashes here.

Provenance

File details

Details for the file pandas_flavor-0.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pandas_flavor-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5ae12ca81813baad0821ecd7316d89575cefac5a00e9e0993d4c337e10dd67f6
MD5 dbc692f0f8531c57f4a8512488bf24ed
BLAKE2b-256 e1c3c9cceafff3247ba7442395f106087e3867d9f741e4fbfb19d77178904a4e

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page