ishareslib 0.1.0

A library for reading data from the ishares product family.

ishareslib

The ishareslib is a library that simplifies the retrieval of data on the ishares product family in python.

By reverse engineering a clear interface was created to be able to process the data easily. During development, care was taken to reduce the number of requests against the ishares server. In addition, custom adapters for user agent and proxy server can be connected to disguise the traffic.

Installing

pip install ishareslib

Usage

This is how you use this interface in your environment:

import Client
from ishareslib.client

client = Client()
client.get_products()  # This will be a pandas dataframe

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them

pip install . .[dev] .[test]

Running the tests

The tests are split into two groups unit tests (without explicit group) and integration test. The unit tests are started with every pull request. The integration tests run time-controlled to detect a change of the ishares interfaces quickly to be able to adapt the library.

How to run unit tests:

pytest -m "not integration"

How to run integration tests:

pytest -m "integration"

The coverage of the tests should always be above 90 percent. Please make sure that your tests are thorough and well thought out.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository

License

This project is licensed under the GNU GENERAL PUBLIC License - see the LICENSE file for details