From aa51b6a03d48bb4a7cec099ded21ba0e0672d678 Mon Sep 17 00:00:00 2001 From: dan Date: Wed, 26 Dec 2018 19:25:16 -0600 Subject: [PATCH] Update README.rst --- README.rst | 101 ++++++++++------------------------------------------- 1 file changed, 18 insertions(+), 83 deletions(-) diff --git a/README.rst b/README.rst index 4212730..fa4efdd 100644 --- a/README.rst +++ b/README.rst @@ -1,90 +1,25 @@ ============ -About ptable +About "PTable" ============ -ptable is a simple Python library designed to make it quick and easy to -represent tabular data in visually appealing ASCII tables, originally -forked from `PrettyTable `_. +See: https://github.com/kxxoling/PTable -.. image:: https://travis-ci.org/kxxoling/ptable.svg - :target: https://travis-ci.org/kxxoling/ptable - :alt: Build Status +=============== +About this fork, +"ptable": +=============== +This is a low effort fork of the super handy "PTable" library by Kane Blueriver +( https://github.com/kxxoling ). This fork is meant to simply address the capitalization +of the library name "PTable", changing it to "ptable" in order to be more pythonic. +I became interested in this issue after trying to build packages for other projects +which depend on this package. -.. image:: https://landscape.io/github/kxxoling/ptable/master/landscape.svg?style=flat - :target: https://landscape.io/github/kxxoling/ptable/master - :alt: Code Health +This issue is described in the original project here: +https://github.com/kxxoling/PTable/issues/13 -.. image:: https://coveralls.io/repos/github/kxxoling/ptable/badge.svg?branch=master - :target: https://coveralls.io/github/kxxoling/ptable?branch=master - :alt: Coverage - - -Installation -============ - -As ptable is a fork of PrettyTable, and compatible with all its APIs, -so ptable is usage is the same as PrettyTable, and the installation -would cover on the original PrettyTable. - -As always, you can install ptable in 3 ways. - -Via pip (recommend):: - - pip install ptable - -Via easy_install:: - - easy_install ptable - -From source:: - - python setup.py install - - -Quick start -=========== - -ptable supports two kinds of usage: - - -As a library ------------- - -ptable library API is almost as PrettyTable, you can import the same API from -``prettytable`` library: - -.. code-block:: python - - from prettytable import PrettyTable - x = PrettyTable() - -A better hosted document is hosted on `ReadTheDocument `_. - - -As command-line tool --------------------- - -This is an original function of ptable, can be used as ``ptable`` command: - -.. code-block:: shell - - ptable --csv somefile.csv - -or a Unix style pipe: - -.. code-block:: shell - - cat somefile.csv | ptable - -Will both print a ASCII table in terminal. - - - -Relative links -============== - -* `Source Code (GitHub) `__ -* `RTFD `__ -* `PyPI `__ -* `PrettyTable `_ +Also trying to test repackaging for pypi: +https://test.pypi.org/project/ptable/ +ptable 0.9.2 +To install this fork of "PTable", "ptable": +'pip install -i https://test.pypi.org/simple/ ptable'