https://github.com/0k/anodb
Simple Database Anonymizer Scripting helper
https://github.com/0k/anodb
Last synced: 11 months ago
JSON representation
Simple Database Anonymizer Scripting helper
- Host: GitHub
- URL: https://github.com/0k/anodb
- Owner: 0k
- License: bsd-2-clause
- Created: 2016-05-13T03:21:15.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-05-13T03:24:13.000Z (about 10 years ago)
- Last Synced: 2025-03-14T17:44:26.122Z (over 1 year ago)
- Language: Python
- Size: 11.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
=========================
anodb
=========================
.. image:: http://img.shields.io/pypi/v/anodb.svg?style=flat
:target: https://pypi.python.org/pypi/anodb/
:alt: Latest PyPI version
.. image:: http://img.shields.io/pypi/dm/anodb.svg?style=flat
:target: https://pypi.python.org/pypi/anodb/
:alt: Number of PyPI downloads
.. image:: http://img.shields.io/travis/0k/anodb/master.svg?style=flat
:target: https://travis-ci.org/0k/anodb/
:alt: Travis CI build status
.. image:: http://img.shields.io/coveralls/0k/anodb/master.svg?style=flat
:target: https://coveralls.io/r/0k/anodb
:alt: Test coverage
``anodb`` is a Python Command Line tool to help you anonymize an existing
database.
Maturity
========
This code is in alpha stage. It wasn't tested on Windows. API may change.
This is more a draft for an ongoing reflection.
Features
========
using ``anodb``:
- You can simply replace fields in your database, conditionally, with
other values if needed.
- You can empty target tables
- And these actions can be saved in a YML file that would batch all
these actions.
- All commands support ``--dry-run`` to see what is the SQL that would
be executed.
Compatibility
=============
This code is python2 ready. It wasn't tested on windows.
Requirements
============
You need ``libpq-dev`` and ``libpython-dev`` package to install it, as
it required python ``psycopg2`` to access the database:
apt-get install libpq-dev libpython-dev
Installation
============
You don't need to download the GIT version of the code as ``anodb`` is
available on the PyPI. So you should be able to run::
pip install anodb
If you have downloaded the GIT sources, then you could add install
the current version via the traditional way::
python setup.py install
And if you don't have the GIT sources but would like to get the latest
master or branch from github, you could also::
pip install git+https://github.com/0k/anodb
Or even select a specific revision (branch/tag/commit)::
pip install git+https://github.com/0k/anodb@master
Usage
=====
Database access
---------------
Before using ``anodb`` you should set up your environment for
password-less access to your target database. This can be done with
several different ways.
#. on the server side: using postgres ``pg_hba.conf`` to set password less
access to some specified login (RECOMMENDED ONLY ON LOCAL SOCKET ACCESS)
#. on the client side, for system authentication: thanks to ``sudo``,
setting a password-less working ``sudo`` access to a user having
system authentication (typically ``sudo -u postgres``).
#. on the client side, using environment variables: setting
``PGUSER``, ``PGPASSWORD``, ``PGDATABASE``, ``PGHOST``,
``PGPORT``...
#. on the client side, using the ``~/.pgpass`` file...
To check the access is fully working you should simply test that
launching ``psql`` alone will connect you without errors to the
correct database.
In a unclear future, a few command line arguments could be added so
that you can provide directly a DSN or the necessary information to
choose and connect to any database.
You can also check access with ``anodb`` itself:
anodb check
Get help
--------
anodb --help
Replace fields
--------------
anodb replace fields --help
Clear Table
-----------
anodb clear table --help
Script
------
The script mode allows you to batch several previous commands in a YML format
This a commented example of such a YML::
env: | ## all values defined here will be accessible to python code
import hashlib
magic_md5 = '$1$'
def gen_salt( length=8, symbols=ascii_letters + digits ):
seed()
return ''.join( sample( symbols, length ) )
actions: ## Batching starts: it's a list of commands
- clear:
- table:
- res_license
- replace:
- field:
- res_partner_contact:
name: "'name_%s' % (id, )"
last_name: "'last_name_%s' % (id, )"
first_name: "'first_name_%s' % (id, )"
- res_partner_contact:
--where: "nom_marital IS NOT NULL"
nom_marital: "'nom_marital_%s' % (id, )"
- res_partner_contact:
--where: "birthdate IS NOT NULL"
birthdate: "'01/01/%s' % birthdate[-4:]"
- res_users:
--where: "login NOT IN ('admin', 'carif1')"
login: "'login_%s' % (id, )"
password: encrypt('test')
name: "'name_%s' % (id, )"
user_email: "'email@valeur.anonyme'"
- sit_public_enquete:
--where: "enqueteur IS NOT NULL"
enqueteur: "'enqueteur_%s' % (id, )"
- res_company:
--where: "id NOT IN (1, 963)"
name: "'company_%s' % (id, )"
- sit_public_passeport_formation:
name: "'name_%s' % (id, )"
organisme: "'organisme_%s' % (id, )"
The script should be launched like this:
anodb script SCRIPT
Contributing
============
Any suggestion or issue is welcome. Push request are very welcome,
please check out the guidelines.
Push Request Guidelines
-----------------------
You can send any code. I'll look at it and will integrate it myself in
the code base and leave you as the author. This process can take time and
it'll take less time if you follow the following guidelines:
- check your code with PEP8 or pylint. Try to stick to 80 columns wide.
- separate your commits per smallest concern.
- each commit should pass the tests (to allow easy bisect)
- each functionality/bugfix commit should contain the code, tests,
and doc.
- prior minor commit with typographic or code cosmetic changes are
very welcome. These should be tagged in their commit summary with
``!minor``.
- the commit message should follow gitchangelog rules (check the git
log to get examples)
- if the commit fixes an issue or finishes the implementation of a
feature, please mention it in the summary.
If you have some questions about guidelines which is not answered here,
please check the current ``git log``, you might find previous commit that
would show you how to deal with your issue.
License
=======
Copyright (c) 2016 Valentin Lab.
Licensed under the `BSD License`_.
.. _BSD License: http://raw.github.com/0k/anodb/master/LICENSE