pwman-python


Namepwman-python JSON
Version 2.4 PyPI version JSON
download
home_pagehttps://bues.ch/h/pwman
SummaryCommandline password manager
upload_time2021-04-18 15:32:33
maintainer
docs_urlNone
authorMichael Buesch
requires_python
license
keywords password manager command line totp 2fa
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            pwman - Commandline password manager
====================================

https://bues.ch/h/pwman

pwman is a commandline based password manager. It encrypts the password database file using strong AES-256 encryption.

pwman has support for the following things:

* Store arbitrary attributes and text data along with the passwords and login credentials.
* Generate two factor authentication tokens (`TOTP <https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm>`_).
* Database search with Regular Expressions or SQL LIKE syntax.
* Database compare (diff). In pwman prompt, at pwman command line and as `git diff` extension.
* Shell-style Tab-completion for all commands.
* Custom Python scripts for arbitrary database processing.
* Export of the complete database as SQL text dump, CSV dump and human readable plain text dump.

Install pwman
=============

pwman does not have to be installed. The `pwman` script can be run directly from the source tree.

However if you want to install pwman, it can be done either directly from the source tree by running the following commands:

.. code:: sh

	./setup.py build
	sudo -i  # Or any other command to become root
	./setup.py install

Or it can be installed vi `PyPi <https://pypi.org/>`_ by running the following commands:

.. code:: sh

	pip3 install -U pyaes
	pip3 install -U pwman-python

Run pwman
=========

Just run the `pwman` executable to start pwman.

Type `pwman -h` for help about the command line options.


pwman prompt
============

If started without options, pwman enters the command prompt:

.. code::

	pwman$

Type the command `help` and press enter to see help about all possible commands.

Command help
============

To get help about a specific command, enter the command into the prompt and append a question mark without spaces in between:

.. code::

	pwman$ find?

Using a custom script to process the database content
=====================================================

A custom Python script can be passed to `pwman` as command line option. Such a script can do anything to the content of the database.

Please see the example script `examplescript.py` for more information.

API documentation
=================

The API documentation can be found in the `API documentation directory <doc/api/>`_.

License / Copyright
===================

Copyright (c) 2011-2021 Michael Buesch <m@bues.ch>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
            

Raw data

            {
    "_id": null,
    "home_page": "https://bues.ch/h/pwman",
    "name": "pwman-python",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "password manager command line TOTP 2FA",
    "author": "Michael Buesch",
    "author_email": "m@bues.ch",
    "download_url": "https://files.pythonhosted.org/packages/a1/26/3d202908892595ea3e9c0ceb94d74e0c35d81599a65fee6efbdeddac8418/pwman-python-2.4.tar.gz",
    "platform": "",
    "description": "pwman - Commandline password manager\n====================================\n\nhttps://bues.ch/h/pwman\n\npwman is a commandline based password manager. It encrypts the password database file using strong AES-256 encryption.\n\npwman has support for the following things:\n\n* Store arbitrary attributes and text data along with the passwords and login credentials.\n* Generate two factor authentication tokens (`TOTP <https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm>`_).\n* Database search with Regular Expressions or SQL LIKE syntax.\n* Database compare (diff). In pwman prompt, at pwman command line and as `git diff` extension.\n* Shell-style Tab-completion for all commands.\n* Custom Python scripts for arbitrary database processing.\n* Export of the complete database as SQL text dump, CSV dump and human readable plain text dump.\n\nInstall pwman\n=============\n\npwman does not have to be installed. The `pwman` script can be run directly from the source tree.\n\nHowever if you want to install pwman, it can be done either directly from the source tree by running the following commands:\n\n.. code:: sh\n\n\t./setup.py build\n\tsudo -i  # Or any other command to become root\n\t./setup.py install\n\nOr it can be installed vi `PyPi <https://pypi.org/>`_ by running the following commands:\n\n.. code:: sh\n\n\tpip3 install -U pyaes\n\tpip3 install -U pwman-python\n\nRun pwman\n=========\n\nJust run the `pwman` executable to start pwman.\n\nType `pwman -h` for help about the command line options.\n\n\npwman prompt\n============\n\nIf started without options, pwman enters the command prompt:\n\n.. code::\n\n\tpwman$\n\nType the command `help` and press enter to see help about all possible commands.\n\nCommand help\n============\n\nTo get help about a specific command, enter the command into the prompt and append a question mark without spaces in between:\n\n.. code::\n\n\tpwman$ find?\n\nUsing a custom script to process the database content\n=====================================================\n\nA custom Python script can be passed to `pwman` as command line option. Such a script can do anything to the content of the database.\n\nPlease see the example script `examplescript.py` for more information.\n\nAPI documentation\n=================\n\nThe API documentation can be found in the `API documentation directory <doc/api/>`_.\n\nLicense / Copyright\n===================\n\nCopyright (c) 2011-2021 Michael Buesch <m@bues.ch>\n\nThis program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.",
    "bugtrack_url": null,
    "license": "",
    "summary": "Commandline password manager",
    "version": "2.4",
    "split_keywords": [
        "password",
        "manager",
        "command",
        "line",
        "totp",
        "2fa"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e7b852b427673d7fba9481e805e61e6a",
                "sha256": "8059a5afde2c86d5e0d9b1be0514082bc0c5222c7a31415e77d8c1732d2c6763"
            },
            "downloads": -1,
            "filename": "pwman-python-2.4.tar.gz",
            "has_sig": true,
            "md5_digest": "e7b852b427673d7fba9481e805e61e6a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 66705,
            "upload_time": "2021-04-18T15:32:33",
            "upload_time_iso_8601": "2021-04-18T15:32:33.341244Z",
            "url": "https://files.pythonhosted.org/packages/a1/26/3d202908892595ea3e9c0ceb94d74e0c35d81599a65fee6efbdeddac8418/pwman-python-2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-04-18 15:32:33",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "pwman-python"
}
        
Elapsed time: 0.24943s