Metadata-Version: 2.1
Name: pyvault
Version: 2.0
Summary: Python password manager
Home-page: https://github.com/gabfl/vault
Author: Gabriel Bordeaux
Author-email: pypi@gab.lc
License: MIT
Platform: UNKNOWN
Classifier: Topic :: Security
Classifier: Topic :: Security :: Cryptography
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Development Status :: 4 - Beta
Requires-Dist: pycryptodome (==3.6.1)
Requires-Dist: pyperclip
Requires-Dist: tabulate
Requires-Dist: argparse
Requires-Dist: passwordgenerator
Requires-Dist: SQLAlchemy
Requires-Dist: pysqlcipher3

Vault
=====

`Pypi <https://pypi.org/project/pyvault>`__ `Build
Status <https://travis-ci.org/gabfl/vault>`__
`codecov <https://codecov.io/gh/gabfl/vault>`__ `MIT
licensed <https://raw.githubusercontent.com/gabfl/vault/master/LICENSE>`__

Vault is a simple Python password manager. It allows you to securely
save secrets with a simple CLI interface.

Features
--------

-  Secrets are stored in an encrypted SQLite database with
   `SQLCipher <https://www.zetetic.net/sqlcipher/>`__
-  Within the database, each password and notes are encrypted with a
   unique salt using AES-256 encryption with
   `pycryptodome <http://legrandin.github.io/pycryptodome/>`__
-  Master key is hashed with a unique salt
-  Possibility to create an unlimited number of vaults
-  Clipboard cleared automatically
-  Automatic vault locking after inactivity
-  Password suggestions with
   `password-generator-py <https://github.com/gabfl/password-generator-py>`__
-  Import / Export in Json

Basic usage
-----------

.. figure:: https://github.com/gabfl/vault/blob/master/img/demo.gif?raw=true
   :alt: Demo

   Demo

Installation and setup
----------------------

Install sqlcipher
~~~~~~~~~~~~~~~~~

Vault 2.x requires ``sqlcipher`` to be installed on your machine.

On MacOS, you can install it with `brew <https://brew.sh/>`__:

.. code:: bash

   brew install sqlcipher

On Ubuntu/Debian, you can install it with apt-get:

.. code:: bash

   sudo apt-get update
   sudo apt-get install --yes gcc python3-dev libsqlcipher-dev

Using PyPI
~~~~~~~~~~

.. code:: bash

   pip3 install pyvault

   # Run setup
   vault

Cloning the project
~~~~~~~~~~~~~~~~~~~

.. code:: bash

   # Clone project
   git clone https://github.com/gabfl/vault && cd vault

   # Installation
   python3 setup.py install

   # Run setup
   vault

Advanced settings:
------------------

::

   usage: vault [-h] [-t [CLIPBOARD_TTL]] [-p [HIDE_SECRET_TTL]]
                [-a [AUTO_LOCK_TTL]] [-v VAULT_LOCATION] [-c CONFIG_LOCATION]
                [-k] [-i IMPORT_ITEMS] [-x EXPORT] [-f [{json}]] [-e]

   optional arguments:
     -h, --help            show this help message and exit
     -t [CLIPBOARD_TTL], --clipboard_TTL [CLIPBOARD_TTL]
                           Set clipboard TTL (in seconds, default: 15)
     -p [HIDE_SECRET_TTL], --hide_secret_TTL [HIDE_SECRET_TTL]
                           Set delay before hiding a printed password (in
                           seconds, default: 15)
     -a [AUTO_LOCK_TTL], --auto_lock_TTL [AUTO_LOCK_TTL]
                           Set auto lock TTL (in seconds, default: 900)
     -v VAULT_LOCATION, --vault_location VAULT_LOCATION
                           Set vault path
     -c CONFIG_LOCATION, --config_location CONFIG_LOCATION
                           Set config path
     -k, --change_key      Change master key
     -i IMPORT_ITEMS, --import_items IMPORT_ITEMS
                           File to import credentials from
     -x EXPORT, --export EXPORT
                           File to export credentials to
     -f [{json}], --file_format [{json}]
                           Import/export file format (default: 'json')
     -e, --erase_vault     Erase the vault and config file


