dsslab-wdc-client 0.20.0

A small client for the WDC-Rest-API.

Description

This project includes a very small client to access data form the WebDataCollector-API. It is meant to provide a simple means of accessing the data in Json or as Panda-DataFrames.

Usage

from dsslab.wdc_client import *

# make sure file ~/.wdc exists. Content:
# WDC_HOST=${the_host_you_are_using}
# WDC_TOKEN=${your_token}
# Alternative ways to initialize: see docs of WDCClient
client = WDCClient.fromEnv(dataframeLib = 'polars') 
df = client.loadAsDataFrame(
	'api/endpoint...', {'param1', 'value will be encoded'})

For more information about the client and usable endpoints, see the project homepage of WDC or directly consult the Documentation.

Changelog

• 0.20.0 Add possibility to choose the DataFrameLibrary: Pandas or Polars
• 0.17.0 Add streaming method WDCClient#streamForEach
• 0.16.1 Add docs
• 0.16.0 Send parameter "body" as BODY
• 0.15.0 WDC.fromEnv uses ~/.wdc file if WDC_HOST has not been previously initialized
• 0.14.0 Added possiblity to pass native dicts and lists to loadAsXXX-methods
• 0.13.0 Add method WDCClient.loadAsDF(endpoint: str, **params) for brevity
• 0.12.0 Fix minor bug for Rate-Limiting.
• 0.11.0 Transparently handle Rate-Limiting from server.
• 0.10.0 Moved to new package structure with the namespace dsslab.

Old changelog

• 0.9.1 Make package obsolete.
• 0.9.0 Add method WDCClient#put to create PUT-Requests
• 0.8.2 Fix for duplicate parameters when paging.
• 0.8.1 Simplify new methods for loading a DomainGraph.
• 0.8.0 Added new methods for loading DomainGraphs.
• 0.7.3 Fix README
• 0.7.2 Include link for generated documentation
• 0.7.1 Added generated documentation
• 0.7.0 Added new method WDCClient.loadDomainGraph for loading a DomainGraph as NetworkX-Object
• 0.6.0 WDCClient throws an WDCException if a request to the server fails
• 0.5.0 New signatures and methods taking care of encodings and working on large results
• 0.4.3 Add dependencies pandas["excel, plot"] as they are likely to be used.
• 0.4.2 Enhance README with Changelog and code-example.
• 0.4.1 Include a preferred variant for creating WDCClients from the Environment