Censor sensitive string data in Python.
Project description
# expurgator
Censor sensitive string data in Python.
[![Build Status](https://travis-ci.org/Iress/expurgator.svg?branch=master)](https://travis-ci.org/Iress/expurgator)
[![Coverage Status](https://coveralls.io/repos/github/Iress/expurgator/badge.svg?branch=master)](https://coveralls.io/github/Iress/expurgator?branch=master)
## Quickstart
Install with:
```sh
pip install expurgator
```
## Usage
Like so:
```python
from expurgator import shallow_dict_expurgator
orig_dict = {'user': 'johnsmith', 'pass': 'supersecret'}
censored_dict = shallow_dict_expurgator(orig_dict)
# censored_dict is now:
# {'user': 'johnsmith', 'pass': '<SensitiveString>'}
```
## Building
To build this library as a wheel:
```sh
python setup.py bdist_wheel --universal
```
## Testing
First, make sure you have pytest installed:
```sh
pip install pytest
```
To run all tests, simply do:
```sh
py.test
```
## Legal
Copyright 2018 [IRESS Ltd](https://www.iress.com/).
License: Apache License 2.0.
Censor sensitive string data in Python.
[![Build Status](https://travis-ci.org/Iress/expurgator.svg?branch=master)](https://travis-ci.org/Iress/expurgator)
[![Coverage Status](https://coveralls.io/repos/github/Iress/expurgator/badge.svg?branch=master)](https://coveralls.io/github/Iress/expurgator?branch=master)
## Quickstart
Install with:
```sh
pip install expurgator
```
## Usage
Like so:
```python
from expurgator import shallow_dict_expurgator
orig_dict = {'user': 'johnsmith', 'pass': 'supersecret'}
censored_dict = shallow_dict_expurgator(orig_dict)
# censored_dict is now:
# {'user': 'johnsmith', 'pass': '<SensitiveString>'}
```
## Building
To build this library as a wheel:
```sh
python setup.py bdist_wheel --universal
```
## Testing
First, make sure you have pytest installed:
```sh
pip install pytest
```
To run all tests, simply do:
```sh
py.test
```
## Legal
Copyright 2018 [IRESS Ltd](https://www.iress.com/).
License: Apache License 2.0.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
expurgator-0.1.0.tar.gz
(2.5 kB
view hashes)