Metadata-Version: 2.0
Name: mikla
Version: 0.2.0
Summary: A command line tool to edit text files encrypted with GnuPG whilst preventing the plaintext from being written to the hard drive.
Home-page: http://dirtymonkey.co.uk/mikla
Author: Matt Deacalion Stevens
Author-email: matt@dirtymonkey.co.uk
License: MIT
Keywords: encryption security gnupg gpg
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX :: BSD
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Communications
Classifier: Topic :: Utilities
Requires-Dist: docopt (>=0.6.2)

=====
Mikla
=====

A command line tool to edit text files encrypted with GnuPG whilst preventing the plaintext from
being written to the hard drive. This is achieved using the POSIX shared memory API. If you have no
available memory, Mikla will not work.

Currently, only works in **Python 3.5**.

Installation
------------
You can install *Mikla* using pip:

.. code-block:: bash

    $ pip install mikla

Usage
-----
Use the `mikla` command to run Mikla::

    $ mikla --help

    Usage:
      mikla [--editor=<editor>] [--tmpfs=<path>] <encrypted-file>
      mikla (-h | --help | --version)

    Options:
      --version                   show program's version number and exit.
      -h, --help                  show this help message and exit.
      -e, --editor=<editor>       specify the editor to use [default: $EDITOR].
      -t, --tmpfs=<path>          the path to a temporary file system [default: /dev/shm].

License
-------
Copyright © 2015 `Matt Deacalion Stevens`_, released under The `MIT License`_.

.. _Matt Deacalion Stevens: http://dirtymonkey.co.uk
.. _MIT License: http://deacalion.mit-license.org


