Skip to content

Commit

Permalink
Merge pull request #8 from HHammond/release_0.0.1
Browse files Browse the repository at this point in the history
Add Release v0.0.1
  • Loading branch information
HHammond committed Jan 17, 2016
2 parents 0e3fce9 + 2b54108 commit c1cb69c
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 6 deletions.
55 changes: 55 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Pretty Pandas
=============

Pretty Pandas uses the new Pandas style API to add beautiful reporting
functionality to Pandas DataFrames.

Features
--------

- Add multiple summary rows and columns.
- A nice and customizable theme.
- Number formatting for currency, scientific units, and percentages.
- Chaining commands
- Works seamlessly with `Pandas Style API <http://pandas.pydata.org/pandas-docs/stable/style.html>`_

`Demo Notebook <http://nbviewer.jupyter.org/github/HHammond/PrettyPandas/blob/master/docs/PrettyPandas%20Demo.ipynb>`_

Installation
------------

::

pip install prettypandas


Documentation
-------------

See the `GitHub page <http://github.com/HHammond/PrettyPandas>`_ for
documentation.

License
-------

The MIT License (MIT)

Copyright (c) 2016 Henry Hammond

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
11 changes: 9 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,23 @@ functionality to Pandas DataFrames.

## Installation

PrettyPandas isn't on PyPI yet. Expect it to be there once tests are finished.
PyPI package:

```sh
pip install prettypandas
```

To install PrettyPandas clone the repository and install it manually:

Manual installation:

```sh
git clone git@github.com:HHammond/PrettyPandas.git
cd PrettyPandas
python setup.py install
```

Pretty Pandas supports Cython versions 2.7, 3.3, 3.4, and 3.5.

## Adding a Summary

PrettyPandas supports:
Expand Down
6 changes: 2 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# Always prefer setuptools over distutils
from setuptools import setup
# To use a consistent encoding
from codecs import open
from os import path

here = path.abspath(path.dirname(__file__))

with open(path.join(here, 'Readme.md'), encoding='utf-8') as f:
with open(path.join(here, 'README.txt'), encoding='utf-8') as f:
long_description = f.read()

setup(
name='prettypandas',

version='0.0.1',
version='0.0.1.post1',

description='Pandas Styler for Report Quality Tables.',
long_description=long_description,
Expand Down

0 comments on commit c1cb69c

Please sign in to comment.