api-keychain 0.6.1

A tool to manage API keys in a secure keychain

API Keychain

Purpose

The API Keychain is designed to be a single management tool for developers to easily create, maintain, and use their various API keys. Many developers work on a variety of projects, many of which require an API key to one service or another. After dealing with even just a few of these keys, it can get frustrating or even overwhelming to manage them, hence this tool.

Usage

Console Commands

api-keychain init

    $ api-keychain init <filename>

The init command creates a new database with the given filename. If a file already exists, it will stop the program and alert you, to avoid overwriting existing keys.

versionadded: 0.4.0

api-keychain store

    $ api-keychain store <filename> <application> <key> [expiration] [userdata]

Use api-keychain store to save a given key to the database. The database name, application name, and key are required, however an expiration date or custom data are optional. Custom data must be provided in a {key: item} dictionary format.

versionadded: 0.2.0

api-keychain retrieve

    $ api-keychain retrieve <filename> <application>

Retrieve a key from the keychain and output it in plaintext. Useful for recovering a key to view/verify.

versionadded: 0.2.0

Accessing the keychain programamtically

The API Keychain is primarily designed for easy access to your keys within other software.

api-keychain.api-retrieve

The most common use for programmatic access will be to automatically retrieve your key from the keychain using a single command.

1. Import api-retrieve using:

   from api-keychain import api-retrieve as your-own-name-here

2. Call the command in your module

   key = api-retrieve(application, password, filename)
   # application: name of the application the key is stored under
   # password: the keychain password which will be verified
   # filename: name of the keychain file

3. The keychain will return your key in plaintext, for use as you see fit.

'versionadded: 0.1.0'

Reference

api-keychain keeps a detailed changelog, as well as an in-depth API Reference for reference.

License

This software is licensed under the GNU GPL 3.0 license

Contributions

Contributions are welcome for the project, whether it be code contributions, corrections, or bug/issue/suggestion reports. See our contribution guidelines!