Skip to main content

Snapshot of data changes in django models

Project 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for unicef_snapshot, version 0.2.3
Filename, size File type Python version Upload date Hashes
Filename, size unicef_snapshot-0.2.3.tar.gz (13.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page