Data

Tools

Indexes

Applications

Experiments

Open Source Science

osparc

python client for osparc-simcore public API

https://github.com/itisfoundation/osparc-simcore-clients

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 (14.5%) to scientific vocabulary

Keywords

osparc osparc-python python
Last synced: 6 months ago · JSON representation ·

Repository

python client for osparc-simcore public API

Basic Info
Statistics
  • Stars: 0
  • Watchers: 10
  • Forks: 5
  • Open Issues: 13
  • Releases: 0
Topics
osparc osparc-python python
Created almost 6 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation Codeowners

README.md

oSPARC-Simcore-Clients

To get started using the tools developed in this repository have a look at the Documentation.

For more in depth knowledge concerning the development of the repository, take a look at

For reporting an issue, use our issue tracker

Development notes

These notes are intended for people who want to contribute to the development of this repository.

The different clients for the oSPARC public API are generated using the openapi-generator-tool. The generated files should not be changed manually! Instead proposed changes should be implemented directly on the openapi-generator-repository. See also templates and customization.

Workflow

See the different clients/<language>/README.md for the workflows for generating the different clients. Here is the workflow which all clients have in common:

  • To generate a client one needs two "ingredients":
    1. The openapi specification which is a json file located in api/openapi.json. This generated in osparc-simcore and then moved here.
    2. The openapi-generator-tool. The exact docker image of this tool to use is specifies in scripts/common.Makefile.

Code lifecycle

This link explains the lifecycle of the osparc client(s) (borrowed from https://www.ibm.com/docs/en/acvfc?topic=manager-product-lifecycle)

Code lifecycle

Documentation

Each client (corresponding to a directory clients/<language>) should have a make recipy called install-doc which installs packages needed to generate the documentation for that client, as well as a make recipe docs which generates the documentation. All of these recipes are called from the root's docs recipe, which is what is called when the website is published.

Repos which depend on this one

Here is an inexhaustive list which have this repo as a dependency. So changing stuff here might break stuff there:

Made with love (and lots of hard work) at www.z43.swiss

Citation (CITATION.cff) 

cff-version: 1.2.0
title: o²S²PARC Clients
message: >-
  If you use this software, please cite it using
  these metadata
type: software
contact:
  - affiliation: "IT'IS Foundation"
    email: "support@osparc.io"
    family-names: Neufeld
    given-names: Esra
authors:
  - given-names: Pedro
    family-names: Crespo-Valero
    orcid: "https://orcid.org/0000-0002-9441-1569"
  - given-names: Elisabetta
    family-names: Iavarone
    affiliation: "IT'IS Foundation"
    orcid: "https://orcid.org/0000-0001-5157-247X"
  - given-names: Mads Rystok
    family-names: Bisgaard
    affiliation: "IT'IS Foundation"
  - given-names: Werner
    family-names: Van Geit
    affiliation: "IT'IS Foundation"
    orcid: "https://orcid.org/0000-0002-2915-720X"
url: "https://itisfoundation.github.io/osparc-simcore-clients/#/"
repository-code: "https://github.com/ITISFoundation/osparc-simcore-clients"

GitHub Events

Total
  • Issues event: 23
  • Issue comment event: 10
  • Push event: 21
  • Pull request review comment event: 49
  • Pull request review event: 64
  • Pull request event: 42
Last Year
  • Issues event: 23
  • Issue comment event: 10
  • Push event: 21
  • Pull request review comment event: 49
  • Pull request review event: 64
  • Pull request event: 42

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 8
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.63
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 8
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.63
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • bisgaard-itis (21)
  • pcrespov (4)
Pull Request Authors
  • bisgaard-itis (49)
  • pcrespov (19)
  • GitHK (2)
  • wvangeit (2)
  • dependabot[bot] (1)
  • elisabettai (1)
Top Labels
Issue Labels
enhancement (13) bug (8) e2e (2) maintenance (2)
Pull Request Labels
bug (25) enhancement (16) documentation (7) maintenance (5) add test (5) e2e (4) dependencies (2) refactoring (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 8,844 last-month
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 8
    (may contain duplicates)
  • Total versions: 63
  • Total maintainers: 2
pypi.org: osparc

osparc.io web API

  • Versions: 33
  • Dependent Packages: 1
  • Dependent Repositories: 8
  • Downloads: 4,479 Last month
Rankings
Dependent packages count: 4.8%
Dependent repos count: 5.2%
Downloads: 5.8%
Average: 12.6%
Forks count: 15.4%
Stargazers count: 31.9%
Maintainers (2)
odeimaiz bisgaard
Last synced: 6 months ago
pypi.org: osparc-client

osparc.io web API (dev)

  • Versions: 30
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 4,365 Last month
Rankings
Dependent packages count: 9.3%
Forks count: 15.4%
Average: 31.2%
Stargazers count: 32.0%
Dependent repos count: 68.2%
Maintainers (1)
bisgaard
Last synced: 6 months ago