Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thombashi committed May 27, 2018
1 parent 4d9f0d6 commit 98ce953
Showing 1 changed file with 23 additions and 6 deletions.
29 changes: 23 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Summary
=========
A CLI tool to convert CSV/Excel/HTML/JSON/LTSV/Markdown/SQLite/TSV/Google-Sheets to a SQLite database file.
A CLI tool to convert CSV / Excel / HTML / JSON / LTSV / Markdown / SQLite / SSV / TSV / Google-Sheets to a SQLite database file.

.. image:: https://img.shields.io/travis/thombashi/sqlitebiter/master.svg?label=Linux
:target: https://travis-ci.org/thombashi/sqlitebiter
Expand Down Expand Up @@ -160,8 +160,11 @@ Python 2.7+ or 3.4+

Python package dependencies are as follows.

Mandatory Python package dependencies
Python package dependencies
------------------------------------------------------------

Mandatory dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Following mandatory Python packages are automatically installed during
``sqlitebiter`` installation process:

Expand All @@ -175,7 +178,7 @@ Following mandatory Python packages are automatically installed during
- `typepy <https://github.com/thombashi/typepy>`__

Google Sheets dependencies (Optional)
------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Following Python packages are required to
`manual installation <http://sqlitebiter.readthedocs.io/en/latest/pages/usage/gs/index.html>`_
when you use Google Sheets feature:
Expand All @@ -184,17 +187,31 @@ when you use Google Sheets feature:
- `oauth2client <https://github.com/google/oauth2client/>`_
- `pyOpenSSL <https://pyopenssl.readthedocs.io/en/stable/>`_

The above packages can be installed with the following pip command;

.. code:: console
$ pip install sqlitebiter[gs]
Test dependencies
------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- `pytablewriter <https://github.com/thombashi/pytablewriter>`__
- `pytest <http://pytest.org/latest/>`__
- `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`__
- `responses <https://github.com/getsentry/responses>`__
- `tox <https://testrun.org/tox/latest/>`__

Misc
Misc dependencies (Optional)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- `lxml <http://lxml.de/installation.html>`__
- `pypandoc <https://github.com/bebraw/pypandoc>`__
- required when converting MediaWiki files


Dependencies other than Python packages (Optional)
------------------------------------------------------------
- `lxml <http://lxml.de/installation.html>`__ (Faster HTML convert if installed)
- ``libxml2`` (faster HTML/Markdown conversion)
- `pandoc <http://pandoc.org/>`__ (required when converting MediaWiki files)

Documentation
===============
Expand Down

0 comments on commit 98ce953

Please sign in to comment.