.. role:: python(code)
:language: python
================
encrypted-config
================
Read and write partially encrypted configuration files.
.. image:: https://img.shields.io/pypi/v/encrypted-config.svg
:target: https://pypi.org/project/encrypted-config
:alt: package version from PyPI
.. image:: https://github.com/mbdevpl/encrypted-config/actions/workflows/python.yml/badge.svg?branch=main
:target: https://github.com/mbdevpl/encrypted-config/actions
:alt: build status from GitHub
.. image:: https://codecov.io/gh/mbdevpl/encrypted-config/branch/main/graph/badge.svg
:target: https://codecov.io/gh/mbdevpl/encrypted-config
:alt: test coverage from Codecov
.. image:: https://api.codacy.com/project/badge/Grade/ba21a054e3cf4f278ad1822017ef1987
:target: https://app.codacy.com/gh/mbdevpl/encrypted-config
:alt: grade from Codacy
.. image:: https://img.shields.io/github/license/mbdevpl/encrypted-config.svg
:target: https://github.com/mbdevpl/encrypted-config/blob/v0.2.0/NOTICE
:alt: license
At present, it is simply an encrypted JSON I/O library.
Because of asymmetric encryption, it enables users to create encrypted configuration files readable only by the target application.
.. contents::
:backlinks: none
How to use
==========
As a library
------------
.. code:: python
import encrypted_config
Details are to be decided.
As a command-line tool
----------------------
To be decided.
How to NOT use
==============
Running this library on an system to which anyone else has access is not secure.
If anyone else can access your private key, they can also decrypt the configuration.
Algorithms
==========
The library relies on RSA.
Requirements
============
Python version 3.8 or later.
Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/encrypted-config/blob/v0.2.0/requirements.txt>`_.
Building and running tests additionally requires packages listed in `<test_requirements.txt>`_.
Tested on Linux, macOS and Windows.
Raw data
{
"_id": null,
"home_page": "https://github.com/mbdevpl/encrypted-config",
"name": "encrypted-config",
"maintainer": "Mateusz Bysiek",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "mateusz.bysiek@gmail.com",
"keywords": "config,encryption,rsa,security",
"author": "Mateusz Bysiek",
"author_email": "mateusz.bysiek@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/98/14/a4fd41f84083495a3f711aed12af9121485bd7cb36ed22d6e78fd5b178cb/encrypted-config-0.2.0.tar.gz",
"platform": null,
"description": ".. role:: python(code)\n :language: python\n\n\n================\nencrypted-config\n================\n\nRead and write partially encrypted configuration files.\n\n.. image:: https://img.shields.io/pypi/v/encrypted-config.svg\n :target: https://pypi.org/project/encrypted-config\n :alt: package version from PyPI\n\n.. image:: https://github.com/mbdevpl/encrypted-config/actions/workflows/python.yml/badge.svg?branch=main\n :target: https://github.com/mbdevpl/encrypted-config/actions\n :alt: build status from GitHub\n\n.. image:: https://codecov.io/gh/mbdevpl/encrypted-config/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/mbdevpl/encrypted-config\n :alt: test coverage from Codecov\n\n.. image:: https://api.codacy.com/project/badge/Grade/ba21a054e3cf4f278ad1822017ef1987\n :target: https://app.codacy.com/gh/mbdevpl/encrypted-config\n :alt: grade from Codacy\n\n.. image:: https://img.shields.io/github/license/mbdevpl/encrypted-config.svg\n :target: https://github.com/mbdevpl/encrypted-config/blob/v0.2.0/NOTICE\n :alt: license\n\nAt present, it is simply an encrypted JSON I/O library.\n\nBecause of asymmetric encryption, it enables users to create encrypted configuration files readable only by the target application.\n\n.. contents::\n :backlinks: none\n\n\nHow to use\n==========\n\n\nAs a library\n------------\n\n.. code:: python\n\n import encrypted_config\n\n\nDetails are to be decided.\n\nAs a command-line tool\n----------------------\n\nTo be decided.\n\n\nHow to NOT use\n==============\n\nRunning this library on an system to which anyone else has access is not secure.\n\nIf anyone else can access your private key, they can also decrypt the configuration.\n\n\nAlgorithms\n==========\n\nThe library relies on RSA.\n\n\nRequirements\n============\n\nPython version 3.8 or later.\n\nPython libraries as specified in `requirements.txt <https://github.com/mbdevpl/encrypted-config/blob/v0.2.0/requirements.txt>`_.\n\nBuilding and running tests additionally requires packages listed in `<test_requirements.txt>`_.\n\nTested on Linux, macOS and Windows.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Read and write partially encrypted configuration files.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/mbdevpl/encrypted-config"
},
"split_keywords": [
"config",
"encryption",
"rsa",
"security"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "037a5853f8cc55d306fe07c4842684be3f649043a260c1c79b5be74445526600",
"md5": "794987808a11edea4efd5bcfaeb71dfc",
"sha256": "d28dbfdf91ea6919e10eba72c35ce315c02ba6da2531d1778ba5945c1b98a86c"
},
"downloads": -1,
"filename": "encrypted_config-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "794987808a11edea4efd5bcfaeb71dfc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12282,
"upload_time": "2024-03-02T11:25:22",
"upload_time_iso_8601": "2024-03-02T11:25:22.638260Z",
"url": "https://files.pythonhosted.org/packages/03/7a/5853f8cc55d306fe07c4842684be3f649043a260c1c79b5be74445526600/encrypted_config-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9814a4fd41f84083495a3f711aed12af9121485bd7cb36ed22d6e78fd5b178cb",
"md5": "191c815696ca2b3c7a4cb0ebc4cb5391",
"sha256": "4c1f740929e2ef2f246d9903ef924331bbc9c599afbd9da02cdc2b6829aa20e0"
},
"downloads": -1,
"filename": "encrypted-config-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "191c815696ca2b3c7a4cb0ebc4cb5391",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16944,
"upload_time": "2024-03-02T11:25:24",
"upload_time_iso_8601": "2024-03-02T11:25:24.423932Z",
"url": "https://files.pythonhosted.org/packages/98/14/a4fd41f84083495a3f711aed12af9121485bd7cb36ed22d6e78fd5b178cb/encrypted-config-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-02 11:25:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mbdevpl",
"github_project": "encrypted-config",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "encrypted-config"
}
JSON
