Initial documentation for Github Pages

Author: zilder

_sources/index.rst.txt

@@ -0,0 +1,95 @@
+
+Testgres documentation
+======================
+
+Testgres is a PostgreSQL testing framework.
+
+Installation
+============
+
+To install testgres, run:
+
+.. code-block:: bash
+
+    pip install testgres
+
+We encourage you to use ``virtualenv`` for your testing environment.
+
+Usage
+=====
+
+Environment
+-----------
+
+Note: by default testgres runs ``initdb``, ``pg_ctl``, ``psql`` provided by ``PATH``.
+
+There are several ways to specify a custom postgres installation:
+
+- export ``PG_CONFIG`` environment variable pointing to the ``pg_config`` executable;
+- export ``PG_BIN`` environment variable pointing to the directory with executable files.
+
+Example:
+
+.. code-block:: bash
+
+    export PG_BIN=$HOME/pg_10/bin
+    python my_tests.py
+
+Examples
+--------
+
+Here is an example of what you can do with ``testgres``:
+
+.. code-block:: python
+
+    # create a node with random name, port, etc
+    with testgres.get_new_node() as node:
+
+        # run inidb
+        node.init()
+
+        # start PostgreSQL
+        node.start()
+
+        # execute a query in a default DB
+        print(node.execute('select 1'))
+
+    # ... node stops and its files are about to be removed
+
+Backup & replication
+--------------------
+
+It's quite easy to create a backup and start a new replica:
+
+.. code-block:: python
+
+    with testgres.get_new_node('master') as master:
+        master.init().start()
+
+        # create a backup
+        with master.backup() as backup:
+
+            # create and start a new replica
+            replica = backup.spawn_replica('replica').start()
+
+            # catch up with master node
+            replica.catchup()
+
+            # execute a dummy query
+            print(replica.execute('postgres', 'select 1'))
+
+Modules
+=======
+
+.. toctree::
+   :maxdepth: 2
+
+   testgres
+
+
+.. Indices and tables
+.. ==================
+
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`

_sources/testgres.rst.txt

@@ -0,0 +1,115 @@
+testgres package
+================
+
+testgres.api
+------------
+
+.. automodule:: testgres.api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.backup
+---------------
+
+.. automodule:: testgres.backup
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.cache
+--------------
+
+.. automodule:: testgres.cache
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.config
+---------------
+
+.. automodule:: testgres.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.connection
+-------------------
+
+.. automodule:: testgres.connection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.consts
+---------------
+
+.. automodule:: testgres.consts
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.decorators
+-------------------
+
+.. automodule:: testgres.decorators
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.defaults
+-----------------
+
+.. automodule:: testgres.defaults
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.enums
+--------------
+
+.. automodule:: testgres.enums
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.exceptions
+-------------------
+
+.. automodule:: testgres.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.logger
+---------------
+
+.. automodule:: testgres.logger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.node
+-------------
+
+.. automodule:: testgres.node
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+testgres.utils
+--------------
+
+.. automodule:: testgres.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: testgres
+    :members:
+    :undoc-members:
+    :show-inheritance: