Giter Club home page Giter Club logo

python-getkeys's Introduction

Python-GetKeys

Micro-package to get a config variable or secrutiy key from a list of possible locations.

I personally tend to keep all my API keys in a few different locations depending on the security needed. This package will simply check that list of locations for the first place the key is found and return it. If the specified key is not found, you have the option to raise an exception or prompt for the user to input the value on the command line.

Configuration

By default the this script will check the following locations. It can be changed by create a new config file at ~/.config/getkeys.json containing a list of key.json files to check.

{
  "paths": [
    "~/.config/keys.json",
    "~/Private/keys/keys.json"
  ]
}

Usage Example

from getkey import getkey

# This example will check the above two files for a value set at
# the json path jira.apikey. If the key is not found in any of the
# files, it will prompt the user for input on the command line.
apikey = getkey('jira.apikey')  

# This does the same as above, but will raise an Exception rather
# than prompting the user for input.
apikey = getkey('jira.apikey', prompt=False)

python-getkeys's People

Contributors

pkkid avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.