Metadata-Version: 2.1
Name: unicef-snapshot
Version: 1.1
Summary: Snapshot of data changes in django models
Home-page: https://github.com/unicef/unicef-snapshot
Author: UNICEF
Author-email: dev@unicef.org
License: Apache 2 License
Platform: any
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Requires-Dist: djangorestframework
Requires-Dist: django-model-utils
Requires-Dist: Django
Provides-Extra: test
Requires-Dist: coverage ; extra == 'test'
Requires-Dist: django-fsm ; extra == 'test'
Requires-Dist: factory-boy ; extra == 'test'
Requires-Dist: faker ; extra == 'test'
Requires-Dist: flake8 ; extra == 'test'
Requires-Dist: isort ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-django ; extra == 'test'
Requires-Dist: pytest-echo ; extra == 'test'
Requires-Dist: pytest-pythonpath ; extra == 'test'
Requires-Dist: psycopg2-binary ; extra == 'test'

UNICEF Snapshot
===============

Snapshot is a library that provides snapshot of data changes on django model.


Installation
------------
    pip install unicef-snapshot


Setup
-----

Add ``unicef_snapshot`` to ``INSTALLED_APPS`` in ``settings.py``

    INSTALLED_APPS = [
        ...
        'unicef_snapshot',

    ]


Usage
-----

Use ``unicef-snapshot`` in serializers

    from unicef_snapshot.serializers import SnapshotModelSerializer

    class ExampleSerializer(SnapshotModelSerializer):
        ...


Contributing
============

Environment Setup
-----------------

To install the necessary libraries

    $ make install


Coding Standards
----------------

See `PEP 8 Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008/>`_ for complete details on the coding standards.

To run checks on the code to ensure code is in compliance

    $ make lint


Testing
-------

Testing is important and tests are located in `tests/` directory and can be run with;

    $ make test

Coverage report is viewable in `build/coverage` directory, and can be generated with;


Project Links
-------------

 - Continuos Integration - https://circleci.com/gh/unicef/unicef-snapshot/tree/develop
 - Source Code - https://github.com/unicef/unicef-snapshot


