Metadata-Version: 2.1
Name: getsecret
Version: 0.0.5
Summary: Reads credentials from a yaml file
Home-page: https://github.com/gkovacs/python-getsecret
Author: Geza Kovacs
Author-email: noreply@gkovacs.com
License: UNKNOWN
Description: # getsecret
        
        Reads credentials from a file `.getsecret.yaml`
        
        ## Install
        
        ```bash
        pip install getsecret
        ```
        
        ## Using
        
        Create a file `.getsecret.yaml`. It should be in YAML format. An example follows:
        
        ```yaml
        username: foobar
        password: supersecret
        ```
        
        Now you can access those variables in your code as follows:
        
        ```python
        from getsecret import getsecret
        username = getsecret('username')
        password = getsecet('password')
        ```
        
        Now the values of username and password are the ones specified in `.getsecret.yaml` (foobar and supersecret, respectively).
        
        The file `.getsecret.yaml` can be located in the working directory (`./.getsecret.yaml`), or at the user's home directory (`~/.getsecret.yaml`)
        
        If you pass an additional parameter, it will be used as the default if the key is not found in `.getsecret.yaml`. For example, the following will look for the `username` key in `.getsecret.yaml`, and will default to `root` if it is not found:
        
        ```python
        from getsecret import getsecret
        username = getsecret('username', 'root')
        ```
        
        ## Author
        
        [Geza Kovacs](https://github.com/gkovacs)
        
        ## License
        
        MIT
        
        ## Related
        
        [getsecret npm package](https://www.npmjs.com/package/getsecret) for javascript on browser/nodejs
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
