Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.rst → README.bak
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
============
About PTable
About ptable
============

PTable is a simple Python library designed to make it quick and easy to
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 <https://code.google.com/p/prettytable/>`_.

.. image:: https://travis-ci.org/kxxoling/PTable.svg
:target: https://travis-ci.org/kxxoling/PTable
.. image:: https://travis-ci.org/kxxoling/ptable.svg
:target: https://travis-ci.org/kxxoling/ptable
:alt: Build Status

.. image:: https://landscape.io/github/kxxoling/PTable/master/landscape.svg?style=flat
:target: https://landscape.io/github/kxxoling/PTable/master
.. image:: https://landscape.io/github/kxxoling/ptable/master/landscape.svg?style=flat
:target: https://landscape.io/github/kxxoling/ptable/master
:alt: Code Health

.. image:: https://coveralls.io/repos/github/kxxoling/PTable/badge.svg?branch=master
:target: https://coveralls.io/github/kxxoling/PTable?branch=master
.. 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
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.
As always, you can install ptable in 3 ways.

Via pip (recommend)::

pip install PTable
pip install ptable

Via easy_install::

easy_install PTable
easy_install ptable

From source::

Expand All @@ -44,13 +44,13 @@ From source::
Quick start
===========

PTable supports two kinds of usage:
ptable supports two kinds of usage:


As a library
------------

PTable library API is almost as PrettyTable, you can import the same API from
ptable library API is almost as PrettyTable, you can import the same API from
``prettytable`` library:

.. code-block:: python
Expand All @@ -64,7 +64,7 @@ A better hosted document is hosted on `ReadTheDocument <http://ptable.readthedoc
As command-line tool
--------------------

This is an original function of PTable, can be used as ``ptable`` command:
This is an original function of ptable, can be used as ``ptable`` command:

.. code-block:: shell

Expand Down
25 changes: 25 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
============
About "PTable"
============

See: https://github.com/kxxoling/PTable

===============
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.

This issue is described in the original project here:
https://github.com/kxxoling/PTable/issues/13

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'
15 changes: 7 additions & 8 deletions docs/_meta.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.. PTable documentation master file, created by
.. ptable documentation master file, created by

==================================
Welcome to PTable's documentation!
Welcome to ptable's documentation!
==================================

PTable is a simple Python library designed to make it quick and easy to
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 <https://code.google.com/p/prettytable/>`_ .

.. image:: https://travis-ci.org/kxxoling/PTable.svg
:target: https://travis-ci.org/kxxoling/PTable
.. image:: https://travis-ci.org/kxxoling/ptable.svg
:target: https://travis-ci.org/kxxoling/ptable
:alt: Build Status

.. image:: https://landscape.io/github/kxxoling/PTable/master/landscape.svg?style=flat
:target: https://landscape.io/github/kxxoling/PTable/master
.. image:: https://landscape.io/github/kxxoling/ptable/master/landscape.svg?style=flat
:target: https://landscape.io/github/kxxoling/ptable/master
:alt: Code Health

Links
Expand All @@ -22,4 +22,3 @@ Links
* `Source Code (GitHub) <https://github.com/kxxoling/PrettyTable>`_
* `PyPI <https://pypi.python.org/pypi/ptabl://pypi.python.org/pypi/ptable>`_
* `RTFD <https://ptable.readthedocs.org>`_

14 changes: 7 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# PTable documentation build configuration file, created by
# ptable documentation build configuration file, created by
# sphinx-quickstart on Sat May 2 13:23:25 2015.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -59,7 +59,7 @@ def _warn_node(self, msg, node):
master_doc = 'index'

# General information about the project.
project = u'PTable'
project = u'ptable'
copyright = u'2015, Kane Blueriver'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -202,7 +202,7 @@ def _warn_node(self, msg, node):
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'PTabledoc'
htmlhelp_basename = 'ptabledoc'


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -222,7 +222,7 @@ def _warn_node(self, msg, node):
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'PTable.tex', u'PTable Documentation',
('index', 'ptable.tex', u'ptable Documentation',
u'Kane Blueriver', 'manual'),
]

Expand Down Expand Up @@ -252,7 +252,7 @@ def _warn_node(self, msg, node):
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'ptable', u'PTable Documentation',
('index', 'ptable', u'ptable Documentation',
[u'Kane Blueriver'], 1)
]

Expand All @@ -266,8 +266,8 @@ def _warn_node(self, msg, node):
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'PTable', u'PTable Documentation',
u'Kane Blueriver', 'PTable', 'One line description of project.',
('index', 'ptable', u'ptable Documentation',
u'Kane Blueriver', 'ptable', 'One line description of project.',
'Miscellaneous'),
]

Expand Down
6 changes: 3 additions & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Installation
------------

PTable is published on PyPI, so you can easily install it via pip or easy_install,
ptable is published on PyPI, so you can easily install it via pip or easy_install,
and pip is recommended::

pip install PTable
pip install ptable

or::

easy_install PTable
easy_install ptable

2 changes: 1 addition & 1 deletion prettytable/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# * Chris Clark
# * Klein Stephane
# * John Filleau
# PTable is forked from original Google Code page in April, 2015, and now
# ptable is forked from original Google Code page in April, 2015, and now
# maintained by Kane Blueriver <kxxoling@gmail.com>.
#
# Redistribution and use in source and binary forms, with or without
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ def fread(filepath):


setup(
name='PTable',
name='ptable',
version=version,
include_package_data=True,
zip_safe=False,
Expand Down Expand Up @@ -38,7 +38,7 @@ def fread(filepath):
author_email='luke@maurits.id.au',
maintainer='Kane Blueriver',
maintainer_email='kxxoling@gmail.com',
url='https://github.com/kxxoling/PTable',
url='https://github.com/kxxoling/ptable',
py_modules=['prettytable', 'prettytable.cli', 'prettytable.prettytable',
'prettytable.factory', 'prettytable._compact'],
test_suite="test_prettytable",
Expand Down