Utilities for using Synapse.
Project description
Synapse Power Tools
Utilities for using Synapse.
Dependencies
- Python3.10+
- A Synapse account with a username/password. Authentication through a 3rd party (.e.g., Google) will not work, you must have a Synapse user/pass for the API to authenticate.
Install
pip install syntools
Configuration
Your Synapse credentials can be provided on the command line (--username
, --password
) or via environment variables.
SYNAPSE_USERNAME=your-synapse-username
SYNAPSE_PASSWORD=your-synapse-password
Usage
usage: syntools [-h] [--version] {download,find-id,copy,move,list} ...
Synapse Power Tools
options:
-h, --help show this help message and exit
--version show program's version number and exit
Commands:
{download,find-id,copy,move,list}
download Download folders and files from Synapse.
find-id Find a Synapse ID by a Synapse path (e.g., MyProject/Folder/file.txt).
copy Copy Synapse entities from one container to another.
move Move Synapse entities from one container to another.
list List Synapse entities in one or more containers.
Development Setup
pipenv --python 3.10
pipenv shell
make pip_install
make build
make install_local
See Makefile for all commands.
Testing
- Create and activate a virtual environment:
- Rename .env-template to .env and set each of the variables.
- Run the tests:
make test
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
syntools-0.0.2.tar.gz
(29.6 kB
view hashes)
Built Distribution
Close
Hashes for syntools-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9f823feab526d053dd11a9d93b089a4e975cac88a59a412067a35bcbe154a5f |
|
MD5 | bdfcd802b8edc8dc1187cbb99356d220 |
|
BLAKE2b-256 | eb3ae4d38843b0a869e0b8cb8cedbd527c9a511902f3d032d53ae69bae02ada7 |