A Python GUI, CLI, and wrapper for Tomb
Project description
Mausoleum consists of a command line application and GUI application wrapped around Tomb (the Crypto Undertaker). Both applications were created with the intention of making it easier for users to interact with Tomb.
Installation
As Mausoleum is purely a wrapper for Tomb, it requires Tomb to be installed locally. For Tomb installation details, please see: https://www.dyne.org/software/tomb/. The Mausoleum GUI application requires PyQt5 to be installed locally. For PyQt5 installation instructions, please visit: https://www.riverbankcomputing.com/software/pyqt/download5.
With your environment set, the following command may be used to install Mausoleum:
$ pip install mausoleum
If you would rather install from source, run:
$ git clone https://github.com/mandeep/Mausoleum.git $ cd Mausoleum $ python setup.py install
GUI Application
To run the GUI application, simply run the following command in a terminal:
$ mausoleum-gui
The command will open a new window that includes tabs that group Tomb functions into separate tabs. The ‘Create’ tab receives information needed to create a new tomb, the ‘Open’ tab allows the user to fill in information regarding the opening of an existing tomb, the ‘Close’ tab lets the user close opened tombs, the ‘Resize’ tab gives the user the ability to resize an existing tomb, the ‘List’ tab displays all active tombs, and the ‘Config’ tab allows the user to make configuration changes to the GUI.
Command Line Application
With Mausoleum installed, the command line application can be invoked with the following commands and arguments:
usage: mausoleum [options] command [arguments] commands: construct Dig, forge, and lock a new tomb enter Open an existing tomb alter Resize an existing tomb mold Create a QR code from an existing tomb key etch Embed an existing tomb key inside a JPEG image resurrect Print to stdout the tomb key embedded within the JPEG image positional arguments: name Name of the new or existing tomb size The size in megabytes for the new tomb key Name of the new or existing tomb key file optional arguments: --open Option that opens a tomb after creation or resizing
If a key is not supplied as a command line argument, the application will search for a key with the name of the tomb with .key as the suffix.
Example of creating a new tomb and opening it thereafter:
$ mausoleum construct --open secret.tomb 100 Password: Repeat for confirmation:
Example of opening an existing tomb:
$ mausoleum enter secret.tomb Password:
Example of resizing an existing tomb:
$ mausoleum alter secret.tomb 200 Password:
Wrapper
Mausoleum may be imported as a module as seen in the following example:
import mausoleum.wrapper
def batch_create_tombs(names, size, password):
"""Take a list of names and batch create tombs."""
for name in names:
key = '{}.key' .format(name)
mausoleum.wrapper.construct_tomb(name, size, key, password)
Contributions
All contributions are welcome! Feel free to submit a pull request for trivial changes. For other changes, please open an issue on the repository’s issue tracker.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for mausoleum-0.10.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83e89b4f9bc938c5386c3f471c22c3926062dcca18a936750c85f5b37106bd41 |
|
MD5 | 117fa8c866caeab3ee6f621c20b43bfa |
|
BLAKE2b-256 | c0e48ef81dded38a5c99d8b2aeef71165256277786990c2025db4b9d2d1a54a8 |