Metadata-Version: 2.1
Name: encrypted-config
Version: 0.1.1
Summary: Partially encrypted configuration library/tool.
Home-page: https://mbdevpl.github.io/
Author: Mateusz Bysiek
Author-email: mb@mbdev.pl
Maintainer: Mateusz Bysiek
Maintainer-email: mb@mbdev.pl
License: Apache License 2.0
Download-URL: https://github.com/mbdevpl/encrypted-config
Keywords: config,encryption,rsa,security
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Communications :: File Sharing
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Utilities
Requires-Python: >=3.4
Requires-Dist: rsa
Requires-Dist: version-query
Requires-Dist: typing (>=3.5); python_version < "3.5"

.. role:: python(code)
    :language: python


================
encrypted-config
================

.. image:: https://img.shields.io/pypi/v/encrypted-config.svg
    :target: https://pypi.org/project/encrypted-config
    :alt: package version from PyPI

.. image:: https://travis-ci.com/mbdevpl/encrypted-config.svg?branch=master
    :target: https://travis-ci.com/mbdevpl/encrypted-config
    :alt: build status from Travis CI

.. image:: https://ci.appveyor.com/api/projects/status/github/mbdevpl/encrypted-config?svg=true
    :target: https://ci.appveyor.com/project/mbdevpl/encrypted-config
    :alt: build status from AppVeyor

.. image:: https://codecov.io/gh/mbdevpl/encrypted-config/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/mbdevpl/encrypted-config
    :alt: test coverage from Codecov

.. image:: https://img.shields.io/pypi/l/encrypted-config.svg
    :target: https://github.com/mbdevpl/encrypted-config/blob/master/NOTICE
    :alt: license

Library and command-line tool for reading and writing of partially encrypted configuration files.

.. contents::
    :backlinks: none


How to use
==========

.. code:: python

    import encrypted_config


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.4 or later.

Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/encrypted-config/blob/v0.1.1/requirements.txt>`_.

Building and running tests additionally requires packages listed in `test_requirements.txt <https://github.com/mbdevpl/encrypted-config/blob/v0.1.1/test_requirements.txt>`_.

Tested on Linux, OS X and Windows.


