ishareslib

Ishareslib

Die Ishareslib ist eine Bibliothek, die das Abrufen von Daten zur Ishares -Produktfamilie in Python vereinfacht.

Durch Reverse Engineering wurde eine klare Schnittstelle erstellt, um die Daten einfach verarbeiten zu können. Während der Entwicklung wurde darauf geachtet, die Anzahl der Anfragen gegen den ISHARES -Server zu verringern. Darüber hinaus können benutzerdefinierte Adapter für Benutzeragenten und Proxy -Server angeschlossen werden, um den Datenverkehr zu verkleiden.

Installation

pip install ishareslib

Verwendung

So verwenden Sie diese Schnittstelle in Ihrer Umgebung:

 import Client
from ishareslib . client

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

Erste Schritte

Mit diesen Anweisungen werden Sie für die Entwicklung und Testzwecke eine Kopie des Projekts auf Ihrer lokalen Maschine in Betrieb genommen.

Voraussetzungen

Welche Dinge benötigen Sie, um die Software zu installieren und wie Sie sie installieren

pip install . .[dev] .[test]

Die Tests ausführen

Die Tests werden in zwei Gruppen -Unit -Tests (ohne explizite Gruppe) und Integrationstest aufgeteilt. Die Unit -Tests werden mit jeder Pull -Anfrage gestartet. Die Integrationstests werden zeitkontrolliert, um eine Änderung der ISHARES-Schnittstellen schnell zu erkennen, um die Bibliothek anzupassen.

So führen Sie Unit -Tests aus:

pytest -m " not integration "

So führen Sie Integrationstests aus:

pytest -m " integration "

Die Abdeckung der Tests sollte immer über 90 Prozent liegen. Bitte stellen Sie sicher, dass Ihre Tests gründlich und gut durchdacht sind.

Versioning

Wir verwenden Semver für die Versionierung. Für die verfügbaren Versionen finden Sie die Tags in diesem Repository

Lizenz

Dieses Projekt ist unter der GNU General Public Lizenz lizenziert - finden Sie in der Lizenzdatei für Einzelheiten