Skip to main content

GitHub Actions pypi version PyPI - Python Version GitHub license

A simple and secure tool to store passwords

Introdution

pyKeyring is a tool to store encrypted passwords in a simple database file.

Installation

Using pip

You need Python 3 installed on your system.

The latest release can be installed from pypi via pip:

foo@bar:~# pip install pykeyring

Manual Installation

Manual installation allows you to run the latest development version from this repository.

pyKeyring depends on TinyDB and Criptography to run.

You can install pyKeyring with all dependecies by running:

foo@bar:~# python setup.py install

Usage

pyKeyring is very simple to use.

Create a database

foo@bar:~$ keyring.py -f /path/to/keyring.db create

The default database file is named keyring.db. If you don’t use the -f argument, pyKeyring will use this name. You can use the -F argument to specify the storage format, BSON (default) or JSON.

Insert a password

foo@bar:~$ keyring.py add password_label

The password_label is used to label your password :)

Get a password

foo@bar:~$ keyring.py get password_label

If you don’t want to print the password in the terminal you can use the argument -c to copy the password to clipboard.

foo@bar:~$ keyring.py get -c password_label

Update a password

foo@bar:~$ keyring.py update password_label

Remove a password

foo@bar:~$ keyring.py remove password_label

Generate a random password

foo@bar:~$ keyring.py generate

If you want to save this with a label you only need to use the -s (–save) argument.

foo@bar:~$ keyring.py generate -s label

You can limit the characteres used to generate the password using the arguments:

  • -l length, –length length

    The length for the generated password [default=12]

  • -u, –no-uppercase

    Don’t use uppercase chars in the password

  • -ll, –no-lowercase

    Don’t use lowercase chars in the password

  • -d, –no-digits

    Don’t use digits in the password

  • -p, –no-punctuation

    Don’t use punctuation chars in the password

  • -e except_chars, –except-chars except_chars

    Don’t use these chars in the password

To generate an 8 digits password you can use:

foo@bar:~$ keyring.py generate -u -ll -p -l 8

Metadata

Release files for pyKeyring 0.6

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

Source distribution (sdist)

Source distribution for pyKeyring 0.6
File Size Uploaded
pyKeyring-0.6.tar.gz 6.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyKeyring 0.6
File Interpreter ABI Platform
pyKeyring-0.6-py3-none-any.whl Python 3 none any Details

Total release size: 16.6 kB

Release files / pyKeyring-0.6.tar.gz

Download URL pyKeyring-0.6.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0727c7ac34fbca9552cc07200ae0759d88f4b0e247b3d2c1879112c20d95122d
BLAKE2b-256 checksum
How to use checksums
05a236c3b830d1f42f9b9101514c012bec37182dca9804a1cfa9885825aa0585
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Release files / pyKeyring-0.6-py3-none-any.whl

Download URL pyKeyring-0.6-py3-none-any.whl
Size 9.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d3a15de4cdd70d7e5fc2f5084941cce1842eab85cf241082b7588494672d2906
BLAKE2b-256 checksum
How to use checksums
1a5d70f00b62c4f1af3c1fca141f4ac62180a0684d687a7daacb3b77d9d26c33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Release history Release notifications | RSS feed

This release

0.6 This release

2 release files

0.5

2 release files

0.4

2 release files

0.3

1 release file

0.2.3

2 release files

0.2.2

1 release file

0.2.1

1 release file

0.2

1 release file

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