Skip to main content

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 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

Metadata

Release files for lockpass-export 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lockpass-export 1.0.0
File Size Uploaded
lockpass_export-1.0.0.tar.gz 15.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lockpass-export 1.0.0
File Interpreter ABI Platform
lockpass_export-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 31.7 kB

Release files / lockpass_export-1.0.0.tar.gz

Download URL lockpass_export-1.0.0.tar.gz
Size 15.5 kB
Tags Source
SHA-256 checksum
How to use checksums
302f731a1145ffc88abe12e85d56c027b583e5668a168f22a988e284e50d68af
BLAKE2b-256 checksum
How to use checksums
241440785b08dc7e0d73c0a5584abcd34197574181949d72687dbd3ee478bbb7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release files / lockpass_export-1.0.0-py3-none-any.whl

Download URL lockpass_export-1.0.0-py3-none-any.whl
Size 16.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
134a73dd753c97a4246fec74c1f1efbe09428bfad5f895ed34f4b459971d5731
BLAKE2b-256 checksum
How to use checksums
00802871cb43e11e9c4a3874a68291dd5b8399185ea4076f5b06b6a486268e18
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page