initial commit

Author: Zsailer

.gitignore

@@ -0,0 +1,104 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+.static_storage/
+.media/
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

README.md

@@ -0,0 +1,22 @@
+# Pandas Flavor
+**Flavor Pandas objects with your own methods and accessors.**
+
+Easily register new methods and accessors with Pandas objects.
+
+![](docs/_images/example.png)
+
+Pandas added `register_series_accessor` and `register_dataframe_accessor` decorators
+in 0.23. These extensions allow you to easily add new accessors to Pandas objects that
+are persistent. This means, you can easily write your own flavor of the DataFrame.
+
+To see an example, checkout [pdvega](). This library adds a new Vega plotting accessor
+under the `vgplot` attribute and mirror the `plot` (matplotlib-based) accessor.
+
+**Pandas Flavor** takes this extension module a step further and adds similar syntax
+for registering new methods!
+
+To see an example, check out [PhyloPandas](https://github.com/Zsailer/phylopandas).
+This library adds extra `to_` methods for writing DataFrames to various biological
+sequencing file formats.
+
+## How it works

docs/_images/example.png

@@ -0,0 +1,4 @@
+from .register import (register_series_method,
+                       register_series_accessor,
+                       register_dataframe_method,
+                       register_dataframe_accessor)

pandas_flavor/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

pandas_flavor/__version__.py

@@ -0,0 +1,26 @@
+try:
+    # Import register decorators from pandas >= 0.23
+    from pandas.api.extensions import (register_dataframe_accessor,
+                                       register_series_accessor)
+except ImportError:
+    try:
+        from pandas.core.accessor import AccessorProperty
+    except ImportError:  # Pandas before 0.22.0
+        from pandas.core.base import AccessorProperty
+
+    # Define register decorators for pandas < 0.23
+    class register_dataframe_accessor(object):
+        """Register custom accessor on DataFrame."""
+        def __init__(self, name):
+            self.name = name
+
+        def __call__(self, accessor):
+            setattr(DataFrame, self.name, AccessorProperty(accessor, accessor))
+
+    class register_series_accessor(object):
+        """Register custom accessor on Series."""
+        def __init__(self, name):
+            self.name = name
+
+        def __call__(self, accessor):
+            setattr(Series, self.name, AccessorProperty(accessor, accessor))

pandas_flavor/pandas_internals.py

@@ -0,0 +1,50 @@
+from .pandas_internals import (register_series_accessor,
+                              register_dataframe_accessor)
+
+
+def register_dataframe_method(method):
+    """Register a function as a method attached to the Pandas DataFrame.
+
+    Example
+    -------
+
+    .. code-block:: python
+
+        @register_dataframe_method
+        def print_column(df, col):
+            '''Print the dataframe column given'''
+            print(df[col])
+    """
+    def inner(*args, **kwargs):
+
+        class AccessorMethod(object):
+            __doc__ = method.__doc__
+
+            def __init__(self, pandas_obj):
+                self._obj = pandas_obj
+
+            def __call__(self, *args, **kwargs):
+                return method(self._obj, *args, **kwargs)
+
+        register_dataframe_accessor(method.__name__)(AccessorMethod)
+
+    return inner()
+
+
+def register_series_method(method):
+    """Register a function as a method attached to the Pandas Series.
+    """
+    def inner(*args, **kwargs):
+
+        class AccessorMethod(object):
+            __doc__ = method.__doc__
+
+            def __init__(self, pandas_obj):
+                self._obj = pandas_obj
+
+            def __call__(self, *args, **kwargs):
+                return method(self._obj, *args, **kwargs)
+
+        register_series_accessor(method.__name__)(AccessorMethod)
+
+    return inner()

pandas_flavor/register.py

@@ -0,0 +1,113 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Note: To use the 'upload' functionality of this file, you must:
+#   $ pip install twine
+
+import io
+import os
+import sys
+from shutil import rmtree
+
+from setuptools import find_packages, setup, Command
+
+# Package meta-data.
+NAME = 'pandas_flavor'
+DESCRIPTION = 'The easy way to write your own Pandas flavor.'
+URL = 'https://github.com/Zsailer/pandas_flavor'
+EMAIL = '[email protected]'
+AUTHOR = 'Zach Sailer'
+
+# What packages are required for this module to be executed?
+REQUIRED = ["pandas"]
+
+# The rest you shouldn't have to touch too much :)
+# ------------------------------------------------
+# Except, perhaps the License and Trove Classifiers!
+# If you do change the License, remember to change the Trove Classifier for that!
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+# Import the README and use it as the long-description.
+# Note: this will only work if 'README.rst' is present in your MANIFEST.in file!
+with io.open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = '\n' + f.read()
+
+# Load the package's __version__.py module as a dictionary.
+about = {}
+with open(os.path.join(here, NAME, '__version__.py')) as f:
+    exec(f.read(), about)
+
+
+class UploadCommand(Command):
+    """Support setup.py upload."""
+
+    description = 'Build and publish the package.'
+    user_options = []
+
+    @staticmethod
+    def status(s):
+        """Prints things in bold."""
+        print('\033[1m{0}\033[0m'.format(s))
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        try:
+            self.status('Removing previous builds…')
+            rmtree(os.path.join(here, 'dist'))
+        except OSError:
+            pass
+
+        self.status('Building Source and Wheel (universal) distribution…')
+        os.system('{0} setup.py sdist bdist_wheel --universal'.format(sys.executable))
+
+        self.status('Uploading the package to PyPi via Twine…')
+        os.system('twine upload dist/*')
+
+        sys.exit()
+
+
+# Where the magic happens:
+setup(
+    name=NAME,
+    version=about['__version__'],
+    description=DESCRIPTION,
+    long_description=long_description,
+    author=AUTHOR,
+    author_email=EMAIL,
+    url=URL,
+    packages=find_packages(exclude=('tests',)),
+    # If your package is a single module, use this instead of 'packages':
+    # py_modules=['mypackage'],
+
+    # entry_points={
+    #     'console_scripts': ['mycli=mymodule:cli'],
+    # },
+    install_requires=REQUIRED,
+    include_package_data=True,
+    license='MIT',
+    classifiers=[
+        # Trove classifiers
+        # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.6',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Programming Language :: Python :: Implementation :: PyPy'
+    ],
+    # $ setup.py publish support.
+    cmdclass={
+        'upload': UploadCommand,
+    },
+)