Metadata-Version: 2.1
Name: configparser_crypt
Version: 0.6.2
Summary: Drop-in replacement for ConfigParser with encryption support
Home-page: https://github.com/netinvent/configparser_crypt
Author: NetInvent - Orsiris de Jong
Author-email: contact@netinvent.fr
License: BSD
Description: # configparser_crypt
        ## Drop-In replacement for ConfigParser with encrypted ini file support
        
        [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
        [![Percentage of issues still open](http://isitmaintained.com/badge/open/netinvent/ofunctions.svg)](http://isitmaintained.com/project/netinvent/configparser_crypt "Percentage of issues still open")
        [![Maintainability](https://api.codeclimate.com/v1/badges/683f2fd6af8fc1c8de73/maintainability)](https://codeclimate.com/github/netinvent/configparser_crypt/maintainability)
        [![codecov](https://codecov.io/gh/netinvent/configparser_crypt/branch/master/graph/badge.svg?token=J7GMZYPYGQ)](https://codecov.io/gh/netinvent/configparser_crypt)
        [![linux-tests](https://github.com/netinvent/configparser_crypt/actions/workflows/linux.yaml/badge.svg)](https://github.com/netinvent/configparser_crypt/actions/workflows/linux.yaml)
        [![windows-tests](https://github.com/netinvent/configparser_crypt/actions/workflows/windows.yaml/badge.svg)](https://github.com/netinvent/configparser_crypt/actions/workflows/windows.yaml)
        [![GitHub Release](https://img.shields.io/github/release/netinvent/configparser_crypt.svg?label=Latest)](https://github.com/netinvent/configparser_crypt/releases/latest)
        
        configparser_crypt is a drop-in replacement for configparser, that allows to read / write encrypted configuration files.
        
        It is compatible with Python 3.5+ and is tested on both Linux and Windows.
        
        ## Setup
        
        ```
        pip install configparser_crypt
        
        ```
        
        ## Usage
        
        Just like configparser, except that we read/write binary files and have a AES key.
        
        
        configparser example
        ```diff
        -from configparser import ConfigParser
        +from configparser_crypt import ConfigParserCrypt
        
        file = 'config.ini'
        -conf_file = ConfigParser()
        +conf_file = ConfigParserCrypt()
        
        # Add some values to the file
        conf_file.add_section('TEST')
        conf_file['TEST']['spam'] = 'eggs'
        
        # Write config file
        -with open(file, 'w') as file_handle:
        -    conf_file.write(file_handle)
        +with open(file, 'wb') as file_handle:
        +    conf_file.write_encrypted(file_handle)
        
        # Read from config file
        -conf_file = ConfigParser()
        -conf_file.read(file)
        +conf_file = ConfigParserCrypt()
        +conf_file.aes_key = secure_key
        +conf_file.read_encrypted(file)
        
        # Check that config file contains 'spam = eggs'
        assert conf_file['TEST']['spam'] == 'eggs'
        ```
        
Keywords: cryptography,configparser,symmetric,cipher,encryption,config file
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Topic :: System
Classifier: Topic :: System :: Operating System
Classifier: Topic :: System :: Shells
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Operating System :: POSIX :: BSD :: NetBSD
Classifier: Operating System :: POSIX :: BSD :: OpenBSD
Classifier: Operating System :: Microsoft
Classifier: Operating System :: Microsoft :: Windows
Classifier: License :: OSI Approved :: BSD License
Description-Content-Type: text/markdown
