Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Pysswords: Manage your passwords from the terminal

Build Test Coverage Code Health

Pysswords lets you manage your login credentials from the terminal. Password files are saved into GPG encrypted files into the database path. Only with the passphrase used to create the pyssword database you can decrypt password file. If you want to know more about how pysswords works, check the Under the Hood section.

Installation

Make sure you have GnuGPG installed.

pip install pysswords

Quickstart

Check the implemented features on the Features section.

# create a new credentials database. Option: `-I` or `--init`
pysswords --init

# add new credentials. Option: `-a` or `--add`
pysswords -a

# get credential with name "github". Option: `-g` or `--get`
pysswords -g github

# delete credential with name "github". Option: `-d` or `--delete`
pysswords -d github

# search credentials with query "github". Option: `-s` or `--search`
pysswords -s github

# copy password from credential named "github" into clipboard. Option: `-c` or `--clipboard`
pysswords -c github

# print all credentials as a table with hidden passwords
pysswords

# print all credentials as a table shows password in plain text. Option: `--show-password`
pysswords --show-password

Contributing

Development status

Latest Version Downloads Supported Python versions

Features

In order of priority [1]:

  • [ ] Database module

  • [ ] Encryption module

  • [ ] Console interface

  • [ ] Group credentials with a password for each group

Under The Hood

Encryption

Encryption is done using GPG. Take a look at pysswords.crypt module to know more.

Database path

The default database path is at ~/.pysswords. If you want to change the database path at database creation pass the –database option to pysswords

pysswords --init --database "/path/to/database/"

Database structure

Pysswords database is structured in a directory hierachy. Every credential is a directory named with credential name inside the database path.

An empty database would look like this:

pysswords --database /tmp/pysswords --init

tree /tmp/pysswords -la
# /tmp/pysswords
# └── .gnupg
#     ├── pubring.gpg
#     ├── random_seed
#     ├── secring.gpg
#     └── trustdb.gpg

After adding a new credential the database would look like this:

pysswords --database /tmp/pysswords -a
#Name: github
#Login: octocat
#Password: **********
#Comments [optional]:

tree /tmp/pysswords -la
#/tmp/pysswords
#├── .gnupg
#│   ├── pubring.gpg
#│   ├── random_seed
#│   ├── secring.gpg
#│   └── trustdb.gpg
#└── github
#    ├── comments
#    ├── login
#    └── password

License (MIT License)

The MIT License (MIT)

Copyright (c) 2014 Marc Webbie, http://github.com/marcwebbie

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Metadata

Release files for pysswords 0.0.5-dev4

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

Source distribution (sdist)

Source distribution for pysswords 0.0.5-dev4
File Size Uploaded Provenance Actions
pysswords-0.0.5-dev4.tar.gz 6.9 kB Without provenance Details for pysswords-0.0.5-dev4.tar.gz

Release files / pysswords-0.0.5-dev4.tar.gz

Download URL pysswords-0.0.5-dev4.tar.gz
Size 6.9 kB
Tags Source
SHA-256 checksum
How to use checksums
13af245458d15344f3d51fd4946b5f6707a80c7775a4b44f7d98548e5f95651f
BLAKE2b-256 checksum
How to use checksums
c95a8489594b2bbb1f0c4e28be52f07f011f22eb945934d12e3c97f3f8c1bc58
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for pysswords 0.0.5-dev4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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