Illumina Basespace filesystem for PyFilesystem2
Project description
Readonly pyfilesystem2 interface to Illumina Basespace
Installing
pip install fs-basespace
Requires python3 version of basespace-python-sdk which can be installed from the develop branch.
pip install 'git+https://github.com/basespace/basespace-python-sdk#egg=BaseSpacePy-0.3&subdirectory=src'
Opening FS Basespace
With class constructor
from fs_basespace import BASESPACEFS
basespacefs = BASESPACEFS("/projects/{project-id}/appresults/{result-id}/files/{file-id}",
client_id = "{client-key}",
client_secret = "{client-secret}",
access_token = "{access_token}",
server_name = "{server_name} optional")
Default server name for Illumina is https://api.basespace.illumina.com/
With connection string
import fs
basespacefs = fs.open_fs("basespace://{clientKey}:{clientSecret}:{appToken}@{server}")
Advanced connection strings
Access to server root directory:
basespace://{clientKey}:{clientSecret}:{appToken}@{server}
Accessing projects:
basespace://{clientKey}:{clientSecret}:{appToken}@{server}!/projects/{projectId}
Accessing project sample files:
basespace://{clientKey}:{clientSecret}:{appToken}@{server}!/projects/{projectId}/samples/{sampleId}/files/{fileId}
Accessing project appResult files (bam, vcf, …):
basespace://{clientKey}:{clientSecret}:{appToken}@{server}!/projects/{projectId}/appresults/{resultId}/files/{fileId}
Downloading files
with open("local_file", "wb") as local_file:
basespacefs.download("path/to/remote/file/id", local_file)
Uploading files
Only readonly access to Basespace is implemented in this package. No upload possible yet.
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
Close
Hashes for fs-basespace-1.2.0.dev2023030600.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | da5eecca1acd9c7e58dc1cf09fc0e892c92e6772f77b67cc5eab8874c0b79d2f |
|
MD5 | bf637ab9a657547c05ff21b5a76e457d |
|
BLAKE2b-256 | e897d04e4eb8b62ad7d0b59405b99264917b15643bcc7218ebcb87f5a3474bfc |