For programmatic upload of files to Cellencis
Project description
biomage-programmatic-interface
About
This python package provides an easy way to create projects and upload samples into Cellenics.
Installation
To install the package execute the following line:
pip install biomage-programmatic-interface
Usage
In order to use the package you first need to create an account in Cellenics (https://scp.biomage.net/) if you don't have one yet.
Then the package is used in the following way:
import biomage_programmatic_interface as bpi
# 1. Authenticate user and create a connection tunnel with the api
# Default instance-url: https://api.scp.biomage.net/
connection = bpi.Connection('email', 'password', 'instance-url')
# 2. Create an experiment
experiment_id = connection.create_experiment()
# 3. Upload samples associated with the experiment
connection.upload_samples(experiment_id, 'local/path/to/samples')
Once the upload is complete you can navigate to Cellenics and process your project there.
Troubleshooting
Max retries exceeded with url: / (Caused by SSLError(SSLEOFError(8, 'EOF occurred in violation of protocol (_ssl.c:2396)')))
- Navigate to your project in Cellenics and manually delete the failed sample
- Run step #3 again
This will be fixed when error handling is introduced
How to build the pip package
Update the version of the package and then build it:
python3 -m build
twine upload dist/*
How to build the docker images
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for biomage_programmatic_interface-0.0.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b331820fd4a61d4aca80bba89ffeb8f084a07c6328177b23846c00eeb7941792 |
|
MD5 | b4341d552cbdd82e4237bacb5ee0eecf |
|
BLAKE2b-256 | 516c90e953f2d93f4db4bc7d43433d246be37cecc8e06fd2beb689bca083cd34 |
Hashes for biomage_programmatic_interface-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 561895f45c04c1b4f3d653b3bbe3996a68f9977124c73fe1925d6939da9c46d6 |
|
MD5 | 360498e7c67b7dfac1a208d37bb34488 |
|
BLAKE2b-256 | ffef5e9f684c0426acf3fc00b64565340340d986eee3813253045ef7b28c1ef9 |