Coscine Python SDK
Coscine, short for Collaborative Scientific Integration Environment, is a platform for Research Data Management. The Coscine Python SDK is an open source package that provides a high-level interface to the Coscine REST API. It enables you to automate research workflows and offers the usual functionality available in the Coscine web interface to python programmers.
Showcase
Uploading a file to a resource:
import coscine
from datetime import datetime
token = "My Coscine API token"
client = coscine.ApiClient(token)
project = client.project("My Project")
resource = project.resource("My Resource")
form = resource.metadata_form()
form["Author"] = "Dr. Akula"
form["Created"] = datetime.now()
form["DAP"] = 3.12
with open("file.csv", "r") as fp:
resource.upload("file.csv", fp, form)
Documentation
Installation instructions and an in-depth guide on using the Python SDK can be found in the online documentation. The source code itself has been heavily annotated with numpy-style DOCstrings. You can generate a local copy of the documentation using Sphinx:
py -m pip install -U requirements.txt
cd docs
set SPHINXBUILD=py -m sphinx.cmd.build
py -m sphinx.ext.apidoc -o . ../src/coscine
make html
Contributing
To report bugs, request features or resolve questions open an issue inside
of the current git repository. Contributions and any help on improving this
package are appreciated. To contribute source code you may fork
the repository and open a merge request or simply submit a short
and relevant snippet or fix inside of an issue.
This package is currently not actively maintained. Merge requests providing
bug fixes or new features will be merged after a short review.
Critical bug fixes will be taken care of. But this package is not affiliated
with the Coscine development team and entirely maintained
by the open source community.
Therefore, if you want to see a change, be the first to implement
it or provide a description of your proposal and ask nicely if somebody else
can implement it for you.
License
This project is Open Source Software and licensed under the terms of the MIT License.
1 maintainer
Metadata
1 maintainer
Release files for coscine 0.12.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| coscine-0.12.2.tar.gz | 205.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| coscine-0.12.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 787.7 kB
Release files / coscine-0.12.2.tar.gz
| Download URL | coscine-0.12.2.tar.gz |
|---|---|
| Size | 205.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
97a7480c93115f7b58b17e75fc7b21a6996b350675688083c8aeb89ff2487e19
|
|
BLAKE2b-256 checksum How to use checksums |
50771e3dffa249d1ec821a052c8dfc98c83599bf8b813e896cdec0dd25abb7cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / coscine-0.12.2-py3-none-any.whl
| Download URL | coscine-0.12.2-py3-none-any.whl |
|---|---|
| Size | 581.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
382b97ffdbb77ae26323236a0f8ca733e229dae572029735d840d0fba02d0a43
|
|
BLAKE2b-256 checksum How to use checksums |
e48ddfd52c151893014e8f4dc11e96a83ef978a70061045ff5045d56d9a6f2da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
