PyShare: A Python Sharing library for DataFrames
This is a library for easy sharing of Python DataFrame objects. It's powered by DuckDB. 🦆
How to install
pip install pyshare-lib
Example usage
import pandas as pd
from pyshare import Share
share = Share("apples", public=True)
df = pd.DataFrame({"tree_id": ["alice", "bob"], "bud_percentage": [42.1, 39.3]})
df.attrs = {"flavor": "sweet/sharp", "country": "The Netherlands"}
share["elstar"] = df
df = pd.DataFrame({"tree_id": ["charlie", "dora"], "bud_percentage": [93.1, 87.3]})
df.attrs = {"flavor": "tart", "country": "Australia"}
share["granny smith"] = df
share
Output:
Share(name="apples", path="md:_share/apples/2fb46588-de57-4a24-9e85-d8cf7ef78be1")
┌──────────────┬──────────────┬────────────────┬─────────────┬─────────────────┐
│ name │ column_count │ estimated_size │ flavor │ country │
│ varchar │ int64 │ int64 │ varchar │ varchar │
├──────────────┼──────────────┼────────────────┼─────────────┼─────────────────┤
│ elstar │ 2 │ 2 │ sweet/sharp │ The Netherlands │
│ granny smith │ 2 │ 2 │ tart │ Australia │
└──────────────┴──────────────┴────────────────┴─────────────┴─────────────────┘
from pyshare import Share
share = Share(name="apples", path="md:_share/apples/2fb46588-de57-4a24-9e85-d8cf7ef78be1")
df = share.get(flavor="sweet/sharp")
df.attrs
Output:
Connecting in read-only mode
{'name': 'elstar', 'flavor': 'sweet/sharp', 'country': 'The Netherlands'}
Configuration
Each share creates a DuckDB database, either on your local machine or on MotherDuck. By default, your shares are saved under ~/.pyshare/data.
To override where local files are stored, set the environment variable PYSHARE_PATH.
To use MotherDuck, export your MotherDuck token to an environment variable MOTHERDUCK_TOKEN.
Fetching and updating data
You can easily find your dataframes by name or any of the attributes you specified:
# any one of these wll give you the elstar table
df = share["elstar"]
df = share.get(name="elstar")
df = share.get(flavor="sweet/sharp")
df = share.get(country="The Netherlands")
# this will get you the granny smith table
df = share["granny smith"]
df = share.get(country="Australia")
# get all matches for a field
for df in share.get_all(tree="large"):
print(df.attrs)
# get a dataframe of all attributes
share.df()
You can update your dataframe like so, which won't update the attributes unless you specify df.attrs:
df = pd.DataFrame({"tree_id": ["alice", "bob", "eva"], "age": ["young", "old", "ancient"]})
share["elstar"] = df
To overwrite or update the attributes without updating the table, run:
# overwrite
share.attrs["elstar"] = {"parentage": ["Ingrid Marie", "Golden Delicious"]}
# update
share.attrs["elstar"]["parentage"] = ["Ingrid Marie", "Golden Delicious"]
share.attrs["elstar"].update({"parentage": ["Ingrid Marie", "Golden Delicious"]})
Happy sharing!
Metadata
Release files for pyshare-lib 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyshare_lib-0.0.3.tar.gz | 6.2 kB | Without provenance | Details for pyshare_lib-0.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyshare_lib-0.0.3-py3-none-any.whl | Python 3 | none | any | Details for pyshare_lib-0.0.3-py3-none-any.whl |
Total release size: 12.4 kB
Security for pyshare-lib 0.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.