Metadata-Version: 2.1
Name: unicef_snapshot
Version: 0.2.3
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
Description: # 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
        
Platform: any
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Provides-Extra: test
