.. image:: mausoleum.png
|pypiversion| |pythonversion| |pypiformat| |license|
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.
.. image:: screenshot.png
:align: center
************
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:
.. code:: python
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.
.. |pypiversion| image:: https://img.shields.io/pypi/v/mausoleum.svg
:target: https://pypi.org/project/mausoleum/
.. |pythonversion| image:: https://img.shields.io/pypi/pyversions/mausoleum.svg
:target: https://pypi.org/project/mausoleum/
.. |pypiformat| image:: https://img.shields.io/pypi/format/mausoleum.svg
:target: https://pypi.org/project/mausoleum/
.. |license| image:: https://img.shields.io/pypi/l/mausoleum.svg
:target: https://pypi.org/project/mausoleum/
Raw data
{
"_id": null,
"home_page": "https://github.com/mandeep/Mausoleum",
"name": "mausoleum",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Mausoleum",
"author": "Mandeep",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/52/7c/99ae5f45286d21f1487b7298b98740e325e2403b5478689c4c57d368897e/mausoleum-0.11.0.tar.gz",
"platform": null,
"description": ".. image:: mausoleum.png\n\n|pypiversion| |pythonversion| |pypiformat| |license|\n\nMausoleum consists of a command line application and GUI application wrapped around Tomb\n(the Crypto Undertaker). Both applications were created with the intention of making\nit easier for users to interact with Tomb.\n\n.. image:: screenshot.png\n :align: center\n\n************\nInstallation\n************\n\nAs Mausoleum is purely a wrapper for Tomb, it requires Tomb to be installed locally. For Tomb installation\ndetails, please see: https://www.dyne.org/software/tomb/. The Mausoleum GUI application requires PyQt5\nto be installed locally. For PyQt5 installation instructions, please visit: https://www.riverbankcomputing.com/software/pyqt/download5.\n\nWith your environment set, the following command may be used to install Mausoleum::\n\n $ pip install mausoleum\n\nIf you would rather install from source, run::\n\n $ git clone https://github.com/mandeep/Mausoleum.git\n $ cd Mausoleum\n $ python setup.py install\n\n***************\nGUI Application\n***************\n\nTo run the GUI application, simply run the following command in a terminal::\n\n $ mausoleum-gui\n\nThe command will open a new window that includes tabs that group Tomb functions into separate\ntabs. The 'Create' tab receives information needed to create a new tomb, the 'Open'\ntab allows the user to fill in information regarding the opening of an existing tomb,\nthe 'Close' tab lets the user close opened tombs, the 'Resize' tab gives the user the ability\nto resize an existing tomb, the 'List' tab displays all active tombs, and the 'Config' tab\nallows the user to make configuration changes to the GUI.\n\n************************\nCommand Line Application\n************************\n\nWith Mausoleum installed, the command line application can be invoked with the following commands and arguments::\n\n usage: mausoleum [options] command [arguments]\n\n commands:\n construct Dig, forge, and lock a new tomb \n enter Open an existing tomb\n alter Resize an existing tomb\n mold Create a QR code from an existing tomb key\n etch Embed an existing tomb key inside a JPEG image\n resurrect Print to stdout the tomb key embedded within the JPEG image\n\n positional arguments:\n name Name of the new or existing tomb\n size The size in megabytes for the new tomb\n key Name of the new or existing tomb key file\n\n optional arguments:\n --open Option that opens a tomb after creation or resizing\n\nIf a key is not supplied as a command line argument, the application will search for a key with\nthe name of the tomb with .key as the suffix.\n\nExample of creating a new tomb and opening it thereafter::\n\n $ mausoleum construct --open secret.tomb 100\n Password:\n Repeat for confirmation:\n\nExample of opening an existing tomb::\n\n $ mausoleum enter secret.tomb\n Password:\n\nExample of resizing an existing tomb::\n\n $ mausoleum alter secret.tomb 200\n Password:\n\n\n*******\nWrapper\n*******\n\nMausoleum may be imported as a module as seen in the following example:\n\n.. code:: python\n\n\n import mausoleum.wrapper\n\n\n def batch_create_tombs(names, size, password):\n \"\"\"Take a list of names and batch create tombs.\"\"\"\n\n for name in names:\n key = '{}.key' .format(name)\n mausoleum.wrapper.construct_tomb(name, size, key, password)\n\n\n*************\nContributions\n*************\n\nAll contributions are welcome! Feel free to submit a pull request for trivial\nchanges. For other changes, please open an issue on the repository's issue tracker.\n\n.. |pypiversion| image:: https://img.shields.io/pypi/v/mausoleum.svg \n :target: https://pypi.org/project/mausoleum/\n.. |pythonversion| image:: https://img.shields.io/pypi/pyversions/mausoleum.svg \n :target: https://pypi.org/project/mausoleum/\n.. |pypiformat| image:: https://img.shields.io/pypi/format/mausoleum.svg\n :target: https://pypi.org/project/mausoleum/\n.. |license| image:: https://img.shields.io/pypi/l/mausoleum.svg\n :target: https://pypi.org/project/mausoleum/\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "A Python GUI, CLI, and wrapper for Tomb",
"version": "0.11.0",
"project_urls": {
"Homepage": "https://github.com/mandeep/Mausoleum"
},
"split_keywords": [
"mausoleum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec4e207db6eacfac96aad15139483cced2efa97d15da1246e194bcb3ae3e6cb9",
"md5": "460cb6a137792fa546f29745279883f8",
"sha256": "c28b791503c6ce355d59bd2189163709ee65819aa4b113b7fbd8aec112248419"
},
"downloads": -1,
"filename": "mausoleum-0.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "460cb6a137792fa546f29745279883f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23100,
"upload_time": "2024-07-29T03:22:34",
"upload_time_iso_8601": "2024-07-29T03:22:34.713025Z",
"url": "https://files.pythonhosted.org/packages/ec/4e/207db6eacfac96aad15139483cced2efa97d15da1246e194bcb3ae3e6cb9/mausoleum-0.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "527c99ae5f45286d21f1487b7298b98740e325e2403b5478689c4c57d368897e",
"md5": "36a7bd2dea4615b5fc54a0493eaeefa5",
"sha256": "7333be993b6842ee31b37a48a64024b4648f81ed089c6202863d2a4b7658fd51"
},
"downloads": -1,
"filename": "mausoleum-0.11.0.tar.gz",
"has_sig": false,
"md5_digest": "36a7bd2dea4615b5fc54a0493eaeefa5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25455,
"upload_time": "2024-07-29T03:22:36",
"upload_time_iso_8601": "2024-07-29T03:22:36.275548Z",
"url": "https://files.pythonhosted.org/packages/52/7c/99ae5f45286d21f1487b7298b98740e325e2403b5478689c4c57d368897e/mausoleum-0.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 03:22:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mandeep",
"github_project": "Mausoleum",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mausoleum"
}
JSON
