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.3.tar.gz
(30.0 kB
view hashes)
Built Distribution
Close
Hashes for syntools-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58526ae3ff0f946ee170a456f91179afd4042b3b2dc0668b62e96f1543632a6e |
|
MD5 | 1e0b51d70dc137162b9c120656e5789e |
|
BLAKE2b-256 | c7fa4f10fe62c1846ad0ba16b7a4f60d8c73e3a8f927a8a211cc96d4dbb56e7a |