Data

Tools

Indexes

Applications

Experiments

Open Source Science

scorpion-client

This project is a high-level interface designed to interact with the API of Scorpion.

https://github.com/ipk-bit/scorpion-client

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

This project is a high-level interface designed to interact with the API of Scorpion.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

Scorpion Client

This project is a high-level interface designed to interact with the API of Scorpion. It provides a convenient way to access and utilize the functionalities of the Scorpion API. Additionally, it includes plugins that enable the extraction of key performance indicators (KPIs) from various monitoring systems. These plugins allow users to easily extract and transform KPI measurements to submit them to Scorpion.

Installation

From release

To install the Scorpion Client from the release, follow these steps:

  1. Download the relevant file from: https://github.com/IPK-BIT/scorpion-client/releases
  2. Install the dependecy with: pip install /path/to/package.tar.gz or pip install /path/to/package.whl

From Source

To install the Scorpion Client from source, follow these steps:

  1. Clone the repository: git clone https://github.com/IPK-BIT/scorpion-client.git
  2. Navigate to the project directory: cd scorpion-client
  3. Install the project dependencies: poetry install

Usage

Basic Usage

To interact with the Scorpion API, create and use the Scorpion Client as follows: ```py from scorpion_client import ScorpionClient

client = ScorpionClient(os.getenv('BASEURL'), os.getenv('APIKEY')) services = client.getServices()

print(services) ```

Data Sources

Scorpion Client includes features to interact with monitoring systems to extract and transform the KPI measurements from. Those features are made available through a Plugin Interface and can be used as follows:

```py from scorpionclient import DataSource from scorpionclient.data_sources.matomo import Matomo

matomo = DataSource('matomo', Matomo(os.getenv('MATOMOBASEURL'), os.getenv('MATOMOAUTHTOKEN'))) webstatdata = matomo.extract({'siteid': os.getenv('MATOMOSITEID'), 'period': 'month', 'date': 'today'}) webstats = matomo.transform(webstatdata) ```

Contributing

Contributions are welcome! If you would like to contribute to the Scorpion Client, please follow these guidelines:

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes and commit them: git commit -m "Add your changes"
  4. Push to the branch: git push origin feature/your-feature-name
  5. Open a pull request

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Owner

  • Name: IPK Gatersleben - Bioinformatics and Information Technology
  • Login: IPK-BIT
  • Kind: organization
  • Location: Germany

Leibniz Institute of Plant Genetics and Crop Plant Research (IPK) Gatersleben

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Scorpion Client
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Manuel
    family-names: Feser
    email: feser@ipk-gatersleben.de
    name-particle: Manuel
    affiliation: IPK Gatersleben.de
    orcid: 'https://orcid.org/0000-0001-6546-1818'
repository-code: 'https://github.com/IPK-BIT/scorpion-client'
keywords:
  - KPI Monitoring
  - Service Monitoring
  - Python Package
license: MIT

GitHub Events

Total
Last Year

Dependencies

poetry.lock pypi
  • annotated-types 0.7.0
  • certifi 2024.7.4
  • charset-normalizer 3.3.2
  • idna 3.7
  • pluggy 1.5.0
  • pydantic 2.8.2
  • pydantic-core 2.20.1
  • requests 2.32.3
  • typing-extensions 4.12.2
  • urllib3 2.2.2
pyproject.toml pypi
  • pluggy ^1.5.0
  • pydantic ^2.8.2
  • python ^3.10
  • requests ^2.32.3
docs/requirements.txt pypi
  • mkdocs-material *
  • mkdocstrings *