Package obsolete
The implementation of this package is obsolete and will not be
maintained any longer. Please use its successor dsslab-wdc-client
available at https://pypi.org/project/dsslab-wdc-client/
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 dss_wdc_client.client import WDCClient
# Somehow initialize environment variables for
# "WDC_HOST" and "WDC_TOKEN".
load_dotenv()
client = WDCClient.fromEnv()
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.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
Internal Notes for the Development Environment
Initialize
wdc-rest-api-python> poetry install --extras docs
Use cases
-
Update dependencies:
poetry update -
Execute Python file:
poetry run python3 src/main.py -
Running tests (https://pytest-with-eric.com/getting-started/poetry-run-pytest/)
poetry run pytest poetry run pytest tests/test_module.py::testFunction poetry run pytest -s (with output from stdout and stderr)
Create Documentation (Sphinx)
`poetry run make html`
Publish to PyPI
(https://python-poetry.org/docs/repositories/#publishable-repositories)
-
Config token (once)
poetry config pypi-token.pypi <my-token> -
Publish
poetry publish --build
Metadata
Release files for dss.wdc_client 0.9.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| dss_wdc_client-0.9.1.tar.gz | 4.9 kB | Without provenance | Details for dss_wdc_client-0.9.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| dss_wdc_client-0.9.1-py3-none-any.whl | Python 3 | none | any | Details for dss_wdc_client-0.9.1-py3-none-any.whl |
Total release size: 10.3 kB
Release files / dss_wdc_client-0.9.1.tar.gz
| Download URL | dss_wdc_client-0.9.1.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
19e36fbeda77977d72ef496ab70b9243de21eb80d3a36ee93713b6faeddfdccf
|
|
BLAKE2b-256 checksum How to use checksums |
30c2cd51f81eaae64ab122cb40afa010744613e4f7428c800be5c48eee624268
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.4 CPython/3.10.12 Linux/5.15.0-144-generic
|
Release files / dss_wdc_client-0.9.1-py3-none-any.whl
| Download URL | dss_wdc_client-0.9.1-py3-none-any.whl |
|---|---|
| Size | 5.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6032ac38aa6b5080963e4f2e7451b740d45d4bfacc5732e4886191d2fc1fdba8
|
|
BLAKE2b-256 checksum How to use checksums |
b8419722f9e2e758611eb23d7e7b604a00bcc129c5b00e8a10dce51d6ceb44af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.4 CPython/3.10.12 Linux/5.15.0-144-generic
|
Security for dss.wdc_client 0.9.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.