Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thombashi committed Aug 16, 2020
1 parent c8f2f46 commit 539bf21
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 36 deletions.
77 changes: 42 additions & 35 deletions README.rst
Expand Up @@ -10,6 +10,10 @@ Summary
:target: https://badge.fury.io/py/pytablewriter
:alt: PyPI package version

.. image:: https://anaconda.org/conda-forge/pytablewriter/badges/version.svg
:target: https://anaconda.org/conda-forge/pytablewriter
:alt: conda-forge package version

.. image:: https://img.shields.io/pypi/pyversions/pytablewriter.svg
:target: https://pypi.org/project/pytablewriter/
:alt: Supported Python versions
Expand Down Expand Up @@ -83,6 +87,44 @@ Features
- Multibyte character support
- ANSI color support

Installation
============

Installation: pip
------------------------------
::

pip install pytablewriter

Some of the formats require additional dependency packages, you can install these packages as follows:

- Elasticsearch
- ``pip install pytablewriter[es]``
- Excel
- ``pip install pytablewriter[excel]``
- HTML
- ``pip install pytablewriter[html]``
- SQLite
- ``pip install pytablewriter[sqlite]``
- TOML
- ``pip install pytablewriter[toml]``
- Install all of the optioanal dependencies
- ``pip install pytablewriter[all]``

Installation: conda
------------------------------
::

conda install -c conda-forge pytablewriter

Installation: apt
------------------------------
::

sudo add-apt-repository ppa:thombashi/ppa
sudo apt update
sudo apt install python3-pytablewriter

Examples
==========
Write tables
Expand Down Expand Up @@ -659,39 +701,6 @@ For more information
More examples are available at
https://pytablewriter.rtfd.io/en/latest/pages/examples/index.html

Installation
============

Installation: pip
------------------------------
::

pip install pytablewriter

Some of the formats require additional dependency packages, you can install these packages as follows:

- Elasticsearch
- ``pip install pytablewriter[es]``
- Excel
- ``pip install pytablewriter[excel]``
- HTML
- ``pip install pytablewriter[html]``
- SQLite
- ``pip install pytablewriter[sqlite]``
- TOML
- ``pip install pytablewriter[toml]``
- Install all of the optioanal dependencies
- ``pip install pytablewriter[all]``

Installation: apt
------------------------------
::

sudo add-apt-repository ppa:thombashi/ppa
sudo apt update
sudo apt install python3-pytablewriter


Dependencies
============
- Python 3.5+
Expand All @@ -718,8 +727,6 @@ Optional dependencies
- ``toml`` extras
- `toml <https://github.com/uiri/toml>`__



Documentation
===============
https://pytablewriter.rtfd.io/
Expand Down
3 changes: 2 additions & 1 deletion docs/make_readme.py
Expand Up @@ -116,10 +116,11 @@ def main():
maker.write_introduction_file("summary.txt")
maker.write_introduction_file("badges.txt")
maker.write_introduction_file("feature.txt")
maker.write_introduction_file("installation.rst")

write_examples(maker)

maker.write_introduction_file("installation.rst")
maker.write_introduction_file("dependencies.rst")

maker.set_indent_level(0)
maker.write_chapter("Documentation")
Expand Down

0 comments on commit 539bf21

Please sign in to comment.