Metadata-Version: 2.1
Name: secret
Version: 0.2
Summary: A simple library to interact with the 'pass' password store generated keys
Home-page: https://github.com/your_username/passlib
Author: Gerry
Author-email: git@caulfield.me
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: python-gnupg

# Table of Contents

1.  [Introduction](#orgd62752b)
2.  [Requirements](#org4bd8b2d)
3.  [Installation](#org36a9193)
4.  [Usage](#org6de910a)
    1.  [Initialization](#orgbb9ea82)
    2.  [Retrieve a Password](#orgde91ac1)
5.  [Development](#org31f826e)
6.  [License](#org648b023)



<a id="orgd62752b"></a>

# Introduction

Secret is a simple Python library designed to interact with the &rsquo;pass&rsquo; password store generated keys.


<a id="org4bd8b2d"></a>

# Requirements

-   Python 3
-   python-gnupg


<a id="org36a9193"></a>

# Installation

To install the Secret library, you can simply use pip:

``` shell
pip install secret
```

<a id="org6de910a"></a>

# Usage


<a id="orgbb9ea82"></a>

## Initialization

First, ensure that you have the \`~/.password-store/\` directory available as the library uses it as the default storage path.


<a id="orgde91ac1"></a>

## Retrieve a Password

To retrieve a decrypted content of a password store entry, use the `get` function:

``` python
from secret

decrypted_content = secret.get("path/to/your/entry")
print(decrypted_content)
```


Make sure you replace `path/to/your/entry`` with the correct relative path (excluding the .gpg extension) to your password store entry.

<a id="org31f826e"></a>

# Development

To contribute or report issues, please visit the [GitHub repository](https://github.com/gerrywastaken/secret).


<a id="org648b023"></a>

# License

MIT



