Skip to main content

Django package that handles exporting of data

Project description

# UNICEF Rest Export

Django Rest Framework data export package that handles export/rendering to JSON, CSV, XLS, and HTML


## Installation

pip install unicef-rest-export


## Setup

Add ``unicef_rest_export`` to ``INSTALLED_APPS`` in settings

INSTALLED_APPS = [
...
'unicef_rest_export',
]


## Usage

A sample model view;

class AuthorView(ExportView):
queryset = Author.objects.all()
serializer_class = serializers.AuthorSerializer


A sample model viewset;

class AuthorViewSet(ExportViewSet):
queryset = Author.objects.all()
serializer_class = serializers.AuthorSerializer


To override or limit the renderers allowed, add ``EXPORT_RENDERERS`` to settings.
The current default is;

EXPORT_RENDERERS = (
"unicef_rest_export.renderers.ExportHTMLRenderer",
"unicef_rest_export.renderers.ExportCSVRenderer",
"unicef_rest_export.renderers.ExportJSONRenderer",
"unicef_rest_export.renderers.ExportExcelRenderer",
)


## 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-rest-export/tree/develop
- Source Code - https://github.com/unicef/unicef-rest-export


## Thanks to

[django-rest-pandas](https://github.com/wq/django-rest-pandas) as a lot of the code was borrowed from that package.

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

unicef_rest_export-0.1.0.tar.gz (13.3 kB view details)

Uploaded Source

File details

Details for the file unicef_rest_export-0.1.0.tar.gz.

File metadata

File hashes

Hashes for unicef_rest_export-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ed2875d442f016fccb84757b424cf5e38b3e8d1b926fdf12a124d17b63b90f35
MD5 64be0f7f9bacdedda69d615cb3bbf8dc
BLAKE2b-256 4ed50fb1baacc2fa618dc5aa9a306e34e9d738f2e219b2622a560d955136631c

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page