From 977c975edaef654e3f825bad8b615cd4b9324ca2 Mon Sep 17 00:00:00 2001 From: kmayerb Date: Sun, 31 May 2020 16:41:14 -0700 Subject: [PATCH] Add setup.py --- README.md | 9 ++++++++- setup.py | 29 +++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 setup.py diff --git a/README.md b/README.md index 5b2c0e4..81ae08f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Keeping NumPy and Pandas attributes of python classes nice and tidy The Zipdist parent class provides methods to classes for saving -NumPy arrays and pandas DataFrame object attributes in a single +NumPy arrays and Pandas DataFrame object attributes in a single `.tar.gz` file and reloading those attributes back into a newinstance. As an added benefit, the `.tar.gz` provides a tidy human-readable @@ -15,6 +15,13 @@ record of your Python class attributes as .csv files, which you can port on over to another platform like R, Excel, Julia, or Matlab. +## Install + +``` +pip install zipdist +``` + + ## Basic Example ``` python diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..f92306f --- /dev/null +++ b/setup.py @@ -0,0 +1,29 @@ +from setuptools import setup, find_packages +PACKAGES = find_packages() + +# read the contents of your README file +from os import path +this_directory = path.abspath(path.dirname(__file__)) +with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f: + long_description = f.read() + +opts = dict(name='zipdist', + maintainer='Koshlan Mayer-Blackwell', + maintainer_email='kmayerbl@fredhutch.org', + description='Tidy saving andeloading of Numpy and Pandas object attributes', + long_description=long_description, + long_description_content_type='text/markdown', + url='https://github.com/kmayerb/zipdist', + license='MIT', + author='Koshlan Mayer-Blackwell', + author_email='kmayerbl@fredhutch.org', + version='0.1.0', + packages=PACKAGES + ) + +install_reqs = [ + 'numpy>=1.18.1', + 'pandas>=0.24.2'] + +if __name__ == "__main__": + setup(**opts, install_requires=install_reqs) \ No newline at end of file