OpenReview Python library

Prerequisites

You need to have Python 2.xx or 3.xx installed. Preferably use versions 3.xx, as we will stop giving support to Python 2.xx.

Installation

There are two ways to install the OpenReview library. Using pip

$ pip install openreview-py

From the repository.

$ git clone https://github.com/iesl/openreview-py.git
$ cd openreview-py
$ pip install -e .

Run Tests

Before you can run the tests you have to have pytest along with pytest-selenium installed.

$ pip install pytest
$ pip install pytest-selenium

Download the corresponding Firefox Selenium driver for your OS from this link. Under openreview-py/tests/ create a drivers directory and place the geckodriver inside that folder. Your folder structure should look like this:

├── openreview-py
│   ├── tests
│   │   ├── data
│   │   ├── drivers
│   │   │    └── geckodriver

You are now all set to run the tests of the library. To do so, you need to have the OpenReview backend running in your localhost by running the following command.

NODE_ENV=circleci node scripts/clean_start_app.js

If you have environment variables set with your OpenReview credentials, make sure to clear them before proceeding.

Inside the openreview-py folder run

$ pytest