Skip to content

Latest commit

 

History

History
121 lines (80 loc) · 4.25 KB

README.rst

File metadata and controls

121 lines (80 loc) · 4.25 KB
Raw

super-csv

PyPI CI Codecov Documentation Supported Python versions License

Generic CSV Processing for Django Apps

Overview

This library provides a CSVProcessor class which should be subclassed to implement your own per-row processing of CSV files. At minimum, override process_row(row).

The mixins support optional checksums of arbitrary columns, and asynchronous processing of files using Celery.

Documentation

Super CSV is a stand alone library that can be used for CSV management, both syncronous and async.

Testing

make requirements

Will install all prerequisites.

make test

Runs the unit tests in local environment.

Using with Docker Devstack

Prerequisite: Have your Open edX https://github.com/edx/devstack properly installed. Note: When you see "from inside the lms" below, it means that you've run make lms-shell from your devstack directory and are on a command prompt inside the LMS container.

  1. Clone this repo into ../src/ directory (relative to your "devstack" repo location). This will mount the directory in a way that is accessible to the lms container.

  2. Clone inside the lms, uninstall super-csv and reinstall your local copy. You can run the following line from inside the lms, or from the host machine run make install-local. This is necessary if one wants to use latest version for testing/development purposes:

    pip uninstall super-csv -y; pip install -e /edx/src/super-csv

  3. Setup dev environment (since virtual environments are recommended for python development, here is an example of using virtualenv. Other tools would work as well). By default, edx containers come with virtualenv preinstalled

    cd /edx/src/super-csv
virtualenv super-csv-env
source super-csv-env/bin/activate
make requirements

  4. That's it.

License

The code in this repository is licensed under the Apache v2 License unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome.

Please read How To Contribute for details.

Even though they were written with edx-platform in mind, the guidelines should be followed for Open edX code in general.

The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you can find it at PULL_REQUEST_TEMPLATE.md.

The issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you can find it at ISSUE_TEMPLATE.md.

Reporting Security Issues

Please do not report security issues in public. Please email security@edx.org.

Getting Help

Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.