Metadata-Version: 2.1
Name: worek
Version: 0.1.0
Summary: Database Backup Command Line Utility
Home-page: https://github.com/level12/worek
Author: Nick Zaccardi
Author-email: nick.zaccardi@level12.io
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: sqlalchemy
Requires-Dist: click
Requires-Dist: psycopg2-binary
Provides-Extra: ci
Requires-Dist: pytest ; extra == 'ci'
Requires-Dist: pytest-cov ; extra == 'ci'
Requires-Dist: flake8 ; extra == 'ci'
Requires-Dist: check-manifest ; extra == 'ci'
Requires-Dist: docutils ; extra == 'ci'

Worek - A Database Backup Tool
##############################

.. image:: https://circleci.com/gh/level12/worek.svg?style=shield
    :target: https://circleci.com/gh/level12/worek
.. image:: https://codecov.io/gh/level12/worek/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/level12/worek


Introduction
---------------

A logical database backup tool.

* Create full binary backups of a PostgreSQL database
* Restore a text or binary backup of a PostgreSQL database
* Can restore a database over the top of an existing database (clears all data
  first) meaning you don't need a super user to restore a database.


Usage
--------------

Create a backup with the contents going to a file

.. code::

  $ worek backup -d database_name -f ./backup.bin


Create a backup with the contents going to STDOUT

.. code::

  $ worek backup -d database_name \
      | openssl enc -aes-256-cbc -pass file:password.txt -md sha256 -d -out backup.bak.enc


Restore a backup from STDIN. Note you have to use the `-F` property to specify
the type of backup you are handing. This is not required when using `-f` and
specifying the file path.

.. code::

  $ openssl enc -aes-256-cbc -pass file:password.txt -md sha256 -d -in backup.bak.enc  \
      |  worek restore -h localhost -d database_name -F c


Supports standard `PG environment variables`

.. code::

  $ PGPORT=5432 worek backup -d database_name -f ./backup.bin


.. _PG environment variables: https://www.postgresql.org/docs/current/libpq-envars.html


Changelog
=========

0.1.0 released 2019-04-03
-------------------------

- Cleanup Piping Mechanism (da86b5b_)
- Setup CI for PG9.6 and PG10 (002640b_)
- Cleanup API and add tests (e5371da_)
- Update Readme (0697703_)
- Add init for packages (78e6ec2_)
- Setup a Postgres Backup Tool (be27b46_)

.. _da86b5b: https://github.com/level12/worek/commit/da86b5b
.. _002640b: https://github.com/level12/worek/commit/002640b
.. _e5371da: https://github.com/level12/worek/commit/e5371da
.. _0697703: https://github.com/level12/worek/commit/0697703
.. _78e6ec2: https://github.com/level12/worek/commit/78e6ec2
.. _be27b46: https://github.com/level12/worek/commit/be27b46



