diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d03f4e6..ff183e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -107,9 +107,9 @@ To run these: The documentation is created using Sphinx. To locally build the documentation, run the following: - + ```bash -sphinx-build docs docs/_build +sphinx-build -a docs docs/_build ``` The documentation can then be viewed at `docs/_build/index.html` diff --git a/docs/about.rst b/docs/about.rst index 6df145c..858f3c4 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -4,13 +4,13 @@ About ===== Licence -======= +^^^^^^^ ETLHelper is distributed under the `LGPL v3.0 licence `__. Copyright: © BGS / UKRI 2019 Presentations -============= +^^^^^^^^^^^^^ For a high level introduction to ``etlhelper``, see the FOSS4GUK 2019 presentation *Open Source Spatial ETL with Python and Apache Airflow*: diff --git a/docs/index.rst b/docs/index.rst index 95dbbe6..80310e5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,11 @@ Welcome to ETLHelper's documentation! ===================================== -.. image:: https://img.shields.io/pypi/v/etlhelper?label=Current%20Release - :target: https://pypi.org/project/etlhelper -.. image:: https://img.shields.io/pypi/dm/etlhelper?label=Downloads%20pypi - -ETLHelper is a Python ETL library to simplify data transfer into and out of databases. - .. toctree:: - :maxdepth: 2 - :caption: Table of contents + :maxdepth: 3 + :hidden: + Home installation etl_functions connecting_to_databases @@ -19,21 +14,25 @@ ETLHelper is a Python ETL library to simplify data transfer into and out of data about api -.. note:: There are a number of breaking changes planned for +.. image:: https://img.shields.io/pypi/v/etlhelper?label=Current%20Release + :target: https://pypi.org/project/etlhelper +.. image:: https://img.shields.io/pypi/dm/etlhelper?label=Downloads%20pypi + +ETLHelper is a Python ETL library to simplify data transfer into and out of databases. + + +.. note:: This documentation corresponds to the upcoming 1.0 release. + Refer to the README.md for the current codebase. + There are a number of breaking changes planned for ``etlhelper`` version 1.0. Please pin the version number in your dependency list to avoid disruption and watch the project on GitHub for notification of new releases. - -See :doc:`installation` for install instructions. - ``etlhelper`` makes it easy to run SQL queries via Python and return the results. It is built upon the `DBAPI2 specification `__ and takes care of cursor management, importing drivers and formatting connection strings, while providing memory-efficient functions to read, write and transform data. This reduces the amount of boilerplate code required to manipulate data within relational databases with Python. -**Features** - - ``fetchall``, ``iter_rows``, ``fetchone`` functions for querying databases - ``execute``, ``executemany``, and ``load`` functions to insert data @@ -53,7 +52,8 @@ This documentation site explains how the main features are used. See the individual function docstrings for full details of parameters and options. -**ETLHelper components** +ETLHelper components +^^^^^^^^^^^^^^^^^^^^ ETLHelper has three components. @@ -68,11 +68,3 @@ It provides convenience methods for checking databases are reachable over a netw The *DbHelper* classes work behind the scenes to smooth out inconsistencies between different database systems. They also apply database-specific optimisations e.g., using the faster ``executebatch`` function for PostgreSQL connections instead of ``executemany``. In normal use, users do not interact with the DbHelper classes. - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` \ No newline at end of file