Metadata-Version: 2.4
Name: lockpass-export
Version: 1.0.0
Summary: CLI tool to export LockSelf/LockPass shared passwords
Keywords: lockself,lockpass,password,export,exporter,cli
Author: Wanadev
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-Expression: GPL-3.0-or-later
License-File: COPYING
Requires-Dist: nox ; extra == "dev"
Requires-Dist: flit ; extra == "dev"
Requires-Dist: black ; extra == "dev"
Requires-Dist: flake8 ; extra == "dev"
Requires-Dist: flake8-pyproject ; extra == "dev"
Requires-Dist: validate-pyproject ; extra == "dev"
Project-URL: changelog, https://github.com/wanadev/lockpass-export?tab=readme-ov-file#changelog
Project-URL: chat, https://discord.gg/BmUkEdMuFp
Project-URL: documentation, https://github.com/wanadev/lockpass-export/blob/master/README.rst
Project-URL: issues, https://github.com/wanadev/lockpass-export/issues
Project-URL: source, https://github.com/wanadev/lockpass-export
Provides-Extra: dev

LockPass Export
===============

LockPass Export is a CLI tool to export shared password from LockSelf's LockPass password manager.


Prerequisite
------------

* Python >= 3.10 (no third-party dependencies)
* A LockPass instance with API option enabled
* An API account with moderator permissions

See `LockSelf documentation <https://support.lockself.com/hc/fr/articles/4412367678226-Qu-est-ce-que-l-API-LockSelf>`__ for more information about the API.


Install
-------

Standalone script
~~~~~~~~~~~~~~~~~

Just use the ``lockpass_export.py`` script from this repository, it works without any dependency beside Python itself.

To run the script, use the following command::

    python3 lockpass_export.py --help


From PyPI
~~~~~~~~~

To install from PyPI, be sure you have a complete Python 3 installation. On Debian and Ubuntu run the following command::

    apt install python3 python3-dev python3-venv

Then create a virtualenv::

    python3 -m venv /opt/lockpass-export.env

and install LockPass Export inside it::

    /opt/lockpass-export.env/bin/pip install lockpass-export

To run the software, use the following command::

    /opt/lockpass-export.env/bin/lockpass-export --help


Usage
-----

::

    usage: lockpass_export.py [-h] [-V] -u URL -a AUTH_TOKEN -l LS_TOKEN [-i ORGANISATION_ID]
                              FOLDER

    CLI tool to export LockSelf/LockPass shared passwords

    positional arguments:
      FOLDER                Folder where files will be written (created if not exists).

    options:
      -h, --help            show this help message and exit
      -V, --version         show program's version number and exit
      -u, --url URL         URL of your LockPass instance (e.g. 'https://yourcompany.lockself-
                            cloud.com')
      -a, --auth-token AUTH_TOKEN
                            API Auth Token
      -l, --ls-token LS_TOKEN
                            API LS Token
      -i, --organisation-id ORGANISATION_ID
                            ID of the organisation to export (default: 1)

Example::

    python3 lockpass_export.py \
        --url https://mycompany.lockself-cloud.com \
        --auth-token XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \
        --ls-token XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \
        ./myexport/


Development
-----------

Install dev dependencies::

    python3 -m venv __env__
    __env__/bin/pip install -e .[dev]

Lint::

    __env__/bin/nox -s lint

Fix coding style::

    __env__/bin/nox -s black_fix



Changelog
---------

* **[NEXT]** (changes on master, but not released yet):

  * Nothing yet ;)

* **v1.0.0:**

  * Initial release

