Skip to main content

Persistent Pandas DataFrame storage and retrieval using a SQL database, CSV files, HDF5, or pickle files.

Project description

TrashPandas Logo

TrashPandas: Persistent Pandas DataFrame Storage and Retrieval

PyPI Latest Release

What is it?

TrashPandas is a Python package that provides persistent Pandas DataFrame storage and retrieval using a SQL database, CSV files, HDF5, or pickle files.

Main Features

Here are just a few of the things that TrashPandas does well:

  • Store Pandas DataFrames in your choice of format. (SQL, CSV, HDF5, pickle)
  • Retrieve the Pandas DataFrame with the same same indexes and data types you stored.
  • Transfer your DataFrames between storage formats.

Where to get it

The source code is currently hosted on GitHub at: https://github.com/eddiethedean/trashpandas

# PyPI
pip install trashpandas

Dependencies

Example

import pandas as pd
import sqlalchemy as sa
import trashpandas as tp

df = pd.DataFrame({'name': ['Joe', 'Bob', 'John'], 'age': [23, 34, 44]})

# Create SqlStorage object with sqlite database connection string.
storage = tp.SqlStorage('sqlite:///test.db')
# or create an engine with SQLAlchemy and pass it into SqlStorage
engine = sa.create_engine('sqlite:///test.db')
storage = tp.SqlStorage(engine)

# Store DataFrame in database as table named 'people'
# and store metadata as table named '_people_metadata'
storage.store(df, 'people') 
# or assign DataFrame to item
storage['people'] = df

# Retrieve DataFrame from SqlStorage object.
df = storage.load('people')
# or use table name key
df = storage['people']

# Delete stored sql table using SqlStorage delete method.
storage.delete('people')
# or use del on table name key
del storage['people']

# Or use functions instead of SqlStorage class
tp.store_df_sql(df, 'people', engine)

df = tp.load_df_sql('people', engine)

tp.delete_table_sql('people', engine)

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

trashpandas-0.0.6.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

trashpandas-0.0.6-py3-none-any.whl (10.8 kB view hashes)

Uploaded Python 3

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