Metadata-Version: 2.0
Name: passpie
Version: 0.1rc1
Summary: Manage your login credentials from the terminal painlessly.
Home-page: https://github.com/marcwebbie/passpie
Author: Marcwebbie
Author-email: marcwebbie@gmail.com
License: License :: OSI Approved :: MIT License
Download-URL: https://pypi.python.org/pypi/passpie
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python
Classifier: Topic :: Security :: Cryptography
Requires-Dist: click (==3.3)
Requires-Dist: colorama (==0.3.3)
Requires-Dist: gnupg (==2.0.1)
Requires-Dist: psutil (==2.2.1)
Requires-Dist: pyperclip (==1.5.9)
Requires-Dist: PyYAML (==3.11)
Requires-Dist: tabulate (==0.7.4)
Requires-Dist: tinydb (==2.2.2)

Passpie: Manage your passwords from the terminal
================================================

`Passpie <https://marcwebbie.github.io/passpie>`__ lets you manage your
login credentials from the terminal. Password files are saved into
`GnuPG <http://en.wikipedia.org/wiki/GNU_Privacy_Guard>`__ encrypted
files into the Database Path\_. Only with the passphrase used to create
the pass database you can decrypt password files. If you want to know
more about how passpie works internally, check Under the Hood section.

.. figure:: https://github.com/marcwebbie/passpie/raw/master/images/passpie.png
   :alt: Passpie console interface

   Passpie console interface

--------------

Features
--------

-  [x] Console interface
-  [x] Manage multiple databases
-  [x] Add, update, remove credentials
-  [x] Copy passwords to clipboard
-  [x] List credentials as a table
-  [x] Colored output
-  [x] Search credentials by name, login or comments
-  [x] Search with regular expression
-  [x] Grouping credentials
-  [x] Configuration by file
-  [ ] Change passphrase and re-encrypt database
-  [x] Exporting Passpie database
-  [x] Importing Passpie database
-  [ ] Importing credentials from
   `1Password <https://agilebits.com/onepassword>`__
-  [x] Randomly generated credential passwords
-  [x] Generate database status report
-  [ ] Undo/Redo updates to the database
-  [ ] Bulk update/remove credentials

--------------

|pypi| |unix\_build| |windows\_build| |coverage|

--------------

Installation
------------

Stable version
~~~~~~~~~~~~~~

Make sure you have `GPG <https://www.gnupg.org/>`__ and
`pip <http://pip.readthedocs.org/en/latest/installing.html>`__
installed:

.. code:: bash

    pip install passpie

Development version
~~~~~~~~~~~~~~~~~~~

The **latest development version** can be installed directly from
GitHub:

.. code:: bash

    $ pip install --upgrade https://github.com/marcwebbie/passpie/tarball/master

Quickstart
----------

.. code:: bash

    # create a new credentials database.
    passpie init

    # add new credentials.
    passpie add foo@example.com

    # edit credential "example".
    passpie update foo@example

    # copy password from credential "foo@example" into system clipboard.
    passpie copy foo@example

    # search credentials by "exam".
    passpie search exam

    # search credentials using regular expressions.
    passpie search 'example\.com|org'

    # remove credential "foo@example".
    passpie remove foo@example

    # check database credential status
    passpie status

    # print all credentials as a table with hidden passwords
    passpie

    # specify other Passpie database. Option `-D` or `--database`
    passpie -D /path/to/other/database

    # shows help. Option `-h` or `--help`
    passpie --help

    # shows version. Option `--version`
    passpie --version

Commands
--------

``init``:
~~~~~~~~~

Initialize database

``add``:
~~~~~~~~

Insert new credential to database

``update``:
~~~~~~~~~~~

Update credential from database

``remove``:
~~~~~~~~~~~

Remove credential from database

``copy``:
~~~~~~~~~

Copy credential password to clipboard

``search``:
~~~~~~~~~~~

Search credentials using regular expression

``status``:
~~~~~~~~~~~

Query database status for maintenance

Tutorials
---------

1) Syncing your database
~~~~~~~~~~~~~~~~~~~~~~~~

Dropbox
^^^^^^^

With Passpie database on default path ``~/.passpie`` and with a Dropbox
shared directory on path ``~/Dropbox``

.. code:: bash

    # move your Passpie database inside your Dropbox directory
    mv ~/.passpie ~/Dropbox/.passpie
    v
    # create a symbolic link to your shared .passpie directory on the default path.
    ln -s ~/Dropbox/.passpie ~/.passpie

Google Drive
^^^^^^^^^^^^

With Passpie database on default path ``~/.passpie`` and with a
GoogleDrive shared directory on path ``~/GoogleDrive``

.. code:: bash

    # move your Passpie database inside your Dropbox directory
    mv ~/.passpie ~/GoogleDrive/.passpie

    # create a symbolic link to your shared .passpie directory on the default path.
    ln -s ~/GoogleDrive/.passpie ~/.passpie

2) Exporting/Importing Passpie databases
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

    # export database to a passpie database file called passpie.db
    # Option: `--export`
    passpie export passpie.db

    # import database from passpie database file called passpie.db
    # Option: `--import`
    passpie import passpie.db

    # import 1password 1pif exported file
    passpie import passwords.1pif/data1.1pif

3) Grouping credentials by name
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Passpie credentials handles multiple logins for each name which groups
credentials by name:

.. code:: bash

    # create john credential
    passpie add jonh@example.com --comment "Jonh main mail"
    #Password: **********

    # create doe credential
    passpie add doe@example.com --comment "No comment"
    #Password: **********

    # listing credentials
    passpie
    ===========  =======  ==========  ===============
    name         login    password    comment
    ===========  =======  ==========  ===============
    example.com  doe      *****       No comment
    example.com  jonh     *****       Jonh main email
    ===========  =======  ==========  ===============

5) Using multiple databases
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sometimes it is useful to have multiple databases with different
passphrases for higher security. This can be done using ``-D`` Passpie
option.

Creating databases on a given directory (ex: ``~/databases``)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: bash

    # create personal Passpie database
    passpie -D ~/databases/personal_passwords init

    # create work Passpie database
    passpie -D ~/databases/work_passwords init

    # create junk Passpie database
    passpie -D ~/databases/junk_passwords init

Adding passwords to specific database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: bash

    # add password to personal Passpie database
    passpie -D ~/databases/personal_passwords add my@example

    # add password to junk Passpie database
    passpie -D ~/databases/junk_passwords add other@example

Adding passwords to specific database
'''''''''''''''''''''''''''''''''''''

.. code:: bash

    # listing specific databases
    passpie -D ~/databases/junk_passwords

Configuring passpie with ``.passpierc``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can override default passpie configuration if you write a .passpierc
file on your home directory. Passpie configuration files must be written
as a valid `yaml <http://yaml.org/>`__ file

Options:

-  colors:
-  black
-  red
-  green
-  yellow
-  blue
-  magenta
-  cyan
-  white
-  headers:
-  fullname
-  name
-  login
-  password
-  comment
-  path: Path to database
-  table\_format:
-  rst
-  simple
-  orgtbl
-  fancy\_grid
-  short\_commands: Use short commands aliases as in ``passpie a`` for
   ``passpie add``
-  true
-  false
-  show\_password:
-  true
-  false

Example ``.passpierc``:
~~~~~~~~~~~~~~~~~~~~~~~

.. code:: yaml

    path: /Users/jon.doe/.passpie
    short_commands: true
    show_password: false
    table_format: fancy_grid
    colors:
      login: green
      name: yellow
      password: cyan
    headers:
      - name
      - login
      - password
      - comment

Under The Hood
--------------

Encryption
~~~~~~~~~~

Encryption is done with **GnuGPG** using
`AES256 <http://en.wikipedia.org/wiki/Advanced_Encryption_Standard>`__.
Take a look at
`passpie.crypt <https://github.com/marcwebbie/passpie/blob/master/passpie/crypt.py>`__
module to know more.

Database Path
~~~~~~~~~~~~~

The default database path is at ``~/.passpie``. If you want to change
the database path, add ``--database`` option to passpie. Together with
``--init`` you can create arbitrary databases.

.. code:: bash

    passpie --init --database "/path/to/another/database/"

Database structure
~~~~~~~~~~~~~~~~~~

Passpie database is structured in a directory hierachy. Every credential
is a ``.pass`` file inside a directory named after a credential group.

An empty database would look like this:

.. code:: bash

    passpie --database /tmp/passpie init

    tree /tmp/passpie -la
    # /tmp/passpie
    # └── .keys

After adding a new credential the database would look like this:

.. code:: bash

    passpie --database /tmp/passpie add octocat@github.com
    # Password: **********

    tree /tmp/passpie -la
    # /tmp/passpie
    # ├── .keys
    # └── github.com
    #     └── octocat.pass

If we add more credentials to group github.com. Directory structure
would be:

.. code:: bash

    passpie --database /tmp/passpie add octocat2@github.com
    # Password: **********

    tree /tmp/passpie -la
    # /tmp/passpie
    # ├── .keys
    # └── github
    #     └── octocat.pass
    #     └── octocat2.pass

Contributing
------------

-  Fork the repository https://github.com/marcwebbie/passpie/fork
-  Read the
   `Makefile <https://github.com/marcwebbie/passpie/blob/master/Makefile>`__
-  Write your tests on ``tests/test.py``
-  If everything is OK. push your changes and make a pull request. ;)

License (`MIT License <http://choosealicense.com/licenses/mit/>`__)
-------------------------------------------------------------------

The MIT License (MIT)

Copyright (c) 2014-2015 Marc Webbie, http://github.com/marcwebbie

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

.. |pypi| image:: https://img.shields.io/pypi/v/passpie.svg?style=flat-square&label=latest%20version
.. |unix\_build| image:: https://img.shields.io/travis/marcwebbie/passpie/master.svg?style=flat-square&label=unix%20build
.. |windows\_build| image:: https://img.shields.io/appveyor/ci/marcwebbie/marcwebbie.svg?style=flat-square&label=windows%20build
.. |coverage| image:: https://img.shields.io/coveralls/marcwebbie/passpie/master.svg?style=flat-square



