apikeyper package

Subpackages

• apikeyper.config package
  • Submodules
  • apikeyper.config.arguments module
    • Arguments
      • Arguments.parse()
      • Arguments.parsed
  • apikeyper.config.paths module
  • Module contents
• apikeyper.crypt package
  • Submodules
  • apikeyper.crypt.encryption_key module
    • EncryptionKey
      • EncryptionKey.export_to_file()
      • EncryptionKey.export_to_keyring()
      • EncryptionKey.export_to_sftp()
    • get_key_from_file()
    • get_key_from_keyring()
    • get_key_from_sftp()
  • Module contents
    • CryptDB
      • CryptDB.decrypt()
      • CryptDB.delete()
      • CryptDB.encrypt()
      • CryptDB.export()
      • CryptDB.load()
      • CryptDB.move()
      • CryptDB.save()
• apikeyper.database package
  • Module contents
    • APIKeyDB
      • APIKeyDB.db_file_path
      • APIKeyDB.conn
      • APIKeyDB.cursor
      • APIKeyDB.add_key()
      • APIKeyDB.close()
      • APIKeyDB.export_db_as_json()
      • APIKeyDB.export_db_as_xml()
      • APIKeyDB.list_keys_for_service()
      • APIKeyDB.list_services()
• apikeyper.log_engine package
  • Submodules
  • apikeyper.log_engine.helpers module
    • CustomFormatter
      • CustomFormatter.format()
    • clean_module_name()
    • is_number()
    • translate_to_logging_level()
  • Module contents
    • log_engine
    • Loggable
      • Loggable.__is_member__()
      • Loggable.create_child_logger()
      • Loggable.log_device
    • Logger
      • Logger.__new__()
      • Logger.find_child_by_name()
      • Logger.get_child()
      • Logger.get_child_names()
      • Logger.instances
      • Logger.set_level()
      • Logger.set_up_console()
      • Logger.set_up_file()
    • add_child()
• apikeyper.ui package
  • Module contents
    • CLI
      • CLI.apikeyper
    • UserInputHandler
      • UserInputHandler.use_gui
      • UserInputHandler.__gui
      • UserInputHandler.get_password()
      • UserInputHandler.prompt()
• apikeyper.utils package
  • Submodules
  • apikeyper.utils.decorators module
    • decorators.py
    • apikey_required()
    • apikey_required_class()
  • Module contents
    • __init__.py
    • PackageChecker
      • PackageChecker.packages_list
      • PackageChecker.check_installed_packages()

Module contents

class apikeyper.APIKeyPER(db_file_path=None)

Bases: object

This class provides a higher-level interface for managing API keys stored in a SQLite database.

db

An instance of the APIKeyDB class for managing API keys.

Type:

APIKeyDB

add_key(service, api_key)

Add a key to database associated with a service.

Parameters:

• service (str) – The service the API key is associated with.

• api_key (str) – The API key associated with the given service.

Returns:

None

delete_key(service)

Deletes an API key for a specific service from the database.

Parameters:

service (str) – The service to delete the key for.

Returns:

None

get_key(service)

Retrieves an API key for a specific service from the database.

Parameters:

service (str) – The service to retrieve the key for.

Returns:

The retrieved API key.

Return type:

str

list_services()

Lists all unique services in the database.

Returns:

A list of all unique services.

Return type:

list