.. image:: https://readthedocs.org/projects/pysecret/badge/?version=latest
:target: https://pysecret.readthedocs.io/index.html
:alt: Documentation Status
.. image:: https://github.com/MacHu-GWU/pysecret-project/workflows/CI/badge.svg
:target: https://github.com/MacHu-GWU/pysecret-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/pysecret-project/branch/master/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/pysecret-project
.. image:: https://img.shields.io/pypi/v/pysecret.svg
:target: https://pypi.python.org/pypi/pysecret
.. image:: https://img.shields.io/pypi/l/pysecret.svg
:target: https://pypi.python.org/pypi/pysecret
.. image:: https://img.shields.io/pypi/pyversions/pysecret.svg
:target: https://pypi.python.org/pypi/pysecret
.. image:: https://img.shields.io/pypi/dm/pysecret.svg
.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
:target: https://github.com/MacHu-GWU/pysecret-project/blob/main/release-history.rst
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/pysecret-project
------
.. image:: https://img.shields.io/badge/Link-Document-green.svg
:target: https://pysecret.readthedocs.io/index.html
.. image:: https://img.shields.io/badge/Link-API-blue.svg
:target: https://pysecret.readthedocs.io/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg
:target: https://pysecret.readthedocs.io/py-modindex.html
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/pysecret-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/pysecret-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/pysecret-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/pysecret#files
Welcome to ``pysecret`` Documentation
==============================================================================
.. contents::
:class: this-will-duplicate-information-and-it-is-still-useful-here
:local:
``pysecret`` is a library to ease your life dealing with secret information.
For example, **if you have a database connection information, so you should not include it in your source code**. ``pysecret`` is the library that provides several options to deploy or access your secret data securely.
**Features**
1. access secret in `Environment Variable <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/01-Environment-Variable.ipynb>`_.
2. access secret `in shell script <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/02-Shell-Script.ipynb>`_.
3. access secret `in json file from Python <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/03-JSON.ipynb>`_.
4. deploy your secret to `AWS Parameter Store <https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html>`_ and use it in your application code, see `AWS Parameter Store example <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/04-AWS-Parameter-Store.ipynb>`_.
5. deploy your secret to `AWS Secret Manager <https://aws.amazon.com/secrets-manager/>`_ and use it in your application code, see `AWS Secret Manager example <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/05-AWS-Secret-Manager.ipynb>`_.
6. use AWS Key Management Service to encrypt or decrypt your data, see `AWS KMS example <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/06-AWS-KMS.ipynb>`_.
Install
------------------------------------------------------------------------------
``pysecret`` is released on PyPI, so all you need is:
.. code-block:: console
$ pip install pysecret
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade pysecret
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/pysecret-project",
"name": "pysecret",
"maintainer": "Unknown",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2e/01/871b00ea1747ed132702ff9f9b25b3f629e30c0801bed66fe4dc838f9300/pysecret-2.2.4.tar.gz",
"platform": "Windows",
"description": ".. image:: https://readthedocs.org/projects/pysecret/badge/?version=latest\n :target: https://pysecret.readthedocs.io/index.html\n :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/pysecret-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/pysecret-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/pysecret-project/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/pysecret-project\n\n.. image:: https://img.shields.io/pypi/v/pysecret.svg\n :target: https://pypi.python.org/pypi/pysecret\n\n.. image:: https://img.shields.io/pypi/l/pysecret.svg\n :target: https://pypi.python.org/pypi/pysecret\n\n.. image:: https://img.shields.io/pypi/pyversions/pysecret.svg\n :target: https://pypi.python.org/pypi/pysecret\n\n.. image:: https://img.shields.io/pypi/dm/pysecret.svg\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/pysecret-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/pysecret-project\n\n\n------\n\n.. image:: https://img.shields.io/badge/Link-Document-green.svg\n :target: https://pysecret.readthedocs.io/index.html\n\n.. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://pysecret.readthedocs.io/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg\n :target: https://pysecret.readthedocs.io/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/pysecret-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/pysecret-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/pysecret-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/pysecret#files\n\n\nWelcome to ``pysecret`` Documentation\n==============================================================================\n\n.. contents::\n :class: this-will-duplicate-information-and-it-is-still-useful-here\n :local:\n\n``pysecret`` is a library to ease your life dealing with secret information.\n\nFor example, **if you have a database connection information, so you should not include it in your source code**. ``pysecret`` is the library that provides several options to deploy or access your secret data securely.\n\n**Features**\n\n1. access secret in `Environment Variable <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/01-Environment-Variable.ipynb>`_.\n2. access secret `in shell script <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/02-Shell-Script.ipynb>`_.\n3. access secret `in json file from Python <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/03-JSON.ipynb>`_.\n4. deploy your secret to `AWS Parameter Store <https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html>`_ and use it in your application code, see `AWS Parameter Store example <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/04-AWS-Parameter-Store.ipynb>`_.\n5. deploy your secret to `AWS Secret Manager <https://aws.amazon.com/secrets-manager/>`_ and use it in your application code, see `AWS Secret Manager example <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/05-AWS-Secret-Manager.ipynb>`_.\n6. use AWS Key Management Service to encrypt or decrypt your data, see `AWS KMS example <https://github.com/MacHu-GWU/pysecret-project/blob/master/examples/06-AWS-KMS.ipynb>`_.\n\n\nInstall\n------------------------------------------------------------------------------\n\n``pysecret`` is released on PyPI, so all you need is:\n\n.. code-block:: console\n\n $ pip install pysecret\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade pysecret\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "utility tool that load secret information safely.",
"version": "2.2.4",
"project_urls": {
"Download": "https://pypi.python.org/pypi/pysecret/2.2.4#downloads",
"Homepage": "https://github.com/MacHu-GWU/pysecret-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5f569bd9b1fc80b7b7fb29da45d894010bcd040bff5aa1edc80aaa8d0301b8a",
"md5": "bbaa0d06612fab9a75f881b69dbce5bc",
"sha256": "7880d933f5647032a21113b79ab83ed0718e852a4f50a41999128a4a55377e16"
},
"downloads": -1,
"filename": "pysecret-2.2.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "bbaa0d06612fab9a75f881b69dbce5bc",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 25659,
"upload_time": "2023-11-18T15:17:58",
"upload_time_iso_8601": "2023-11-18T15:17:58.343765Z",
"url": "https://files.pythonhosted.org/packages/b5/f5/69bd9b1fc80b7b7fb29da45d894010bcd040bff5aa1edc80aaa8d0301b8a/pysecret-2.2.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e01871b00ea1747ed132702ff9f9b25b3f629e30c0801bed66fe4dc838f9300",
"md5": "20544964e3bd8c97259c3093e39dcc5a",
"sha256": "abd780868a39388897ac4b6cd59973b586bc8f18771154168925d268466dea29"
},
"downloads": -1,
"filename": "pysecret-2.2.4.tar.gz",
"has_sig": false,
"md5_digest": "20544964e3bd8c97259c3093e39dcc5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26268,
"upload_time": "2023-11-18T15:18:00",
"upload_time_iso_8601": "2023-11-18T15:18:00.086201Z",
"url": "https://files.pythonhosted.org/packages/2e/01/871b00ea1747ed132702ff9f9b25b3f629e30c0801bed66fe4dc838f9300/pysecret-2.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-18 15:18:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "pysecret-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "pysecret"
}
JSON
