v2.6.0

Bug Fixes

• [SYNPY-1204] - Python 3.10 compatibility

Stories

• [SYNPY-728] - Improve error message when pandas is not available
• [SYNPY-974] - Documentation for generateManifest
• [SYNPY-1209] - Support for MaterializedViews in Py Client

Tasks

• [SYNPY-1174] - Add function to create Synapse config file
• [SYNPY-1176] - syncToSynapse aborted + silent failure of file upload
• [SYNPY-1184] - Add includeTypes to synapseutils.walk()
• [SYNPY-1189] - Document "maximumListLength" parameter for Column
• [SYNPY-1196] - Expose forceVersion on changeFileMetadata
• [SYNPY-1205] - Python 3.6 EOL - Remove support for 3.6
• [SYNPY-1212] - Include dataset as an entity type to return in getChildren()

Contributors: @danlu1 , @BrunoGrandePhD , @thomasyu888

Full Changelog: v2.5.1...v2.6.0-rc

v2.6.0-rc

Bug Fixes

• [SYNPY-1204] - Python 3.10 compatibility

Stories

• [SYNPY-728] - Improve error message when pandas is not available
• [SYNPY-974] - Documentation for generateManifest
• [SYNPY-1209] - Support for MaterializedViews in Py Client

Tasks

• [SYNPY-1174] - Add function to create Synapse config file
• [SYNPY-1176] - syncToSynapse aborted + silent failure of file upload
• [SYNPY-1184] - Add includeTypes to synapseutils.walk()
• [SYNPY-1189] - Document "maximumListLength" parameter for Column
• [SYNPY-1196] - Expose forceVersion on changeFileMetadata
• [SYNPY-1205] - Python 3.6 EOL - Remove support for 3.6
• [SYNPY-1212] - Include dataset as an entity type to return in getChildren()

Contributors: @danlu1 , @BrunoGrandePhD , @thomasyu888

Full Changelog: v2.5.1...v2.6.0-rc

v2.5.1

Bug Fixes

• [SYNPY-1197] - Schema is a string and strings don't have columns_to_store attributes

Stories

• [SYNPY-772] - update statement that appears on PyPi about Synapse to be consistent
• [SYNPY-997] - Typos in Views documentation

Contributors: @thomasyu888, @danlu1

New Contributors

• @danlu1 made their first contribution in #892

GitHub Changelog: v2.5.0...v2.5.1

v2.5.0

Highlights

• Added ability to generate a manifest file from your local directory structure.

  # from the command line
  # write the manifest to manifest.tsv
  synapse manifest --parent-id syn123 --manifest-file ./manifest.tsv /path/to/local/directory
  # stdout
  synapse manifest --parent-id syn123 /path/to/local/directory
  

• Added ability to pipe manifest stdout into sync function.

  # from the command line
  synapse manifest --parent-id syn123 ./docs/ | synapse sync -
  

• Added ability to return summary statistics of csv and tsv files stored in Synapse.

  # from python
  import synapseclient
  import synapseutils
  syn = synapseclient.login()
  statistics = synapseutils.describe(syn=syn, entity="syn12345")
  print(statistics)
  {
      "column1": {
          "dtype": "object",
          "mode": "FOOBAR"
      },
      "column2": {
          "dtype": "int64",
          "mode": 1,
          "min": 1,
          "max": 2,
          "mean": 1.4
      },
      "column3": {
          "dtype": "bool",
          "mode": false,
          "min": false,
          "max": true,
          "mean": 0.5
      }
  }
  

• Next major release (3.0.0) there will be major cosmetic changes to the cli such as removing all camel case or non-standard single dash long command line interface (cli) parameters.
  Example: command line arguments like -parent will become --parent. Commands that support camel case like --parentId will be changed to --parent-id.

Bug Fixes

• [SYNPY-669] - Signing of Synapse authentication header does not correctly URL encode the URL path
• [SYNPY-770] - Files failing to upload using syncToSynapse
• [SYNPY-1123] - All tables erroring when indexing
• [SYNPY-1146] - Error writing Booleans from Python dataframes into Boolean columns in a Synapse table
• [SYNPY-1156] - datetimes in a Pandas dataframe are not properly stored to Synapse

Stories

• [SYNPY-726] - mirror local folder structure for bulk upload
• [SYNPY-1163] - Expose synId with syn get -r
• [SYNPY-1165] - Generate manifest template from local folder structure
• [SYNPY-1167] - Support for Quick Summary Statistics on CSV and TSV files

Tasks

• [SYNPY-1169] - Integration tests failures in develop branch against stack-371
• [SYNPY-1172] - Passing a pandas dataframe with a column called "read" breaks the type parsing in as_table_columns()
• [SYNPY-1173] - Support DATE_LIST, ENTITYID_LIST, USERID_LIST table columns
• [SYNPY-1188] - Support piping of synapse manifest stdout in synapse sync function

@jkiang13, @linchiahuisage, @esurface, @thomasyu888, @BrunoGrandePhD, @mattfazza

New Contributors

• @esurface made their first contribution in #876
• @mattfazza made their first contribution in #877

Full Changelog: v2.4.0...v2.5.0

v2.4.0

Highlights

• Added ability to authenticate from a SYNAPSE_AUTH_TOKEN environment variable set with a valid personal access token.

# e.g. set environment variable prior to invoking a Synapse command or running a program that uses synapseclient
SYNAPSE_AUTH_TOKEN='<my_personal_access_token>' synapse <subcommand options>

The environment variable will take priority over credentials in the user’s .synapseConfig file or any credentials saved in a prior login using the remember me option.

See here for more details on usage.

• Added ability to silence all console output.

# from the command line, use the --silent option with any synapse subcommand, here it will suppress the download progress indicator
synapse --silent get <synid>

# from code using synapseclient, pass the silent option to the Synapse constructor
import synapseclient

syn = synapseclient.Synapse(silent=True)
syn.login()
syn.get(<synid>)

• Improved robustness during downloads with unstable connections. Specifically the client will automatically recover when encoutering some types of network errors that previously would have caused a download to start over as indicated by a reset progress bar.

Bug Fixes

• [SYNPY-198] - get: Unmet access requirement should not raise error if entity not downloadable
• [SYNPY-959] - FileEntity 'path' property has wrong separator in Windows
• [SYNPY-1113] - Confusing error when putting the positional FILE at the end of the synapse store command with an optional n-arg
• [SYNPY-1128] - failures downloading 14G vcf file
• [SYNPY-1130] - Migration tool trying to move URL-linked data
• [SYNPY-1134] - 500 error during part copy to AWS presigned url
• [SYNPY-1135] - Exceeding part limit during AD Migration
• [SYNPY-1136] - Connection aborted to AWS part copy to presigned url during AD Migration
• [SYNPY-1141] - synapse get command line nargs usage/error
• [SYNPY-1150] - Boolean-like string columns being reformatted (TRUE/FALSE to True/False)
• [SYNPY-1158] - race condition in test_caching.py#test_threaded_access
• [SYNPY-1159] - logging in with an email address and an authToken gives spurious error
• [SYNPY-1161] - ChunkEncodingError encountered from external collaborator during a synapseclient download

Improvements

• [SYNPY-638] - add after date to cache purge
• [SYNPY-929] - silent parameter for all functions which default to writing to stdout
• [SYNPY-1068] - Should show some progress indicator during upload md5 calculation
• [SYNPY-1125] - Allow login with environment variables

Stories

• [SYNPY-1138] - When using boto3 client to upload a file, also include ACL to give bucket owner full access

Tasks

• [SYNPY-948] - command line client set-annotations does not return proper error code when there's a problem
• [SYNPY-1024] - remove reference to deprecated 'status' field from Evaluation
• [SYNPY-1115] - Setting provenance in store ignored for tables
• [SYNPY-1143] - indicate in CLI doc's that select statement requires double quotes

v2.3.1

Highlights

• Entities can be annotated with boolean datatypes, e.g.:

  file = synapseclient.File('/path/to/file', parentId='syn123', synapse_is_great=True)
  syn.store(file)

• synapseclient is additionally packaged as a Python wheel.

Bug Fixes

• [SYNPY-829] - syn.store always updates annotations
• [SYNPY-1033] - If versionComment is left blank, previous version comment populates

Improvements

• [SYNPY-1120] - Build wheel distributions
• [SYNPY-1129] - support boolean annotations in Python client

v2.3.0

Highlights

• The index_files_for_migration and migrate_indexed_files functions are added to synapseutils to help migrate files in Synapse projects and folders between AWS S3 buckets in the same region. More details on using these utilities can be found here.

• This version supports login programatically and from the command line using personal access tokens that can be obtained from your synapse.org Settings. Additional documentation on login and be found here.

  # programmatic
  syn = synapseclient.login(authToken=<token>)

  # command line
  synapse login -p <token>

• The location where downloaded entities are cached can be customized to a location other than the user’s home directory. This is useful in environments where writing to a home directory is not appropriate (e.g. an AWS lambda).

  syn = synapseclient.Synapse(cache_root_dir=<directory path>)

• A helper method on the Synapse object has been added to enable obtaining the Synapse certification quiz status of a user.

  passed = syn.is_certified(<username or user_id>)

• This version has been tested with Python 3.9.

Bug Fixes

• [SYNPY-1039] - tableQuery asDataFrame() results with TYPE_LIST columns should be lists and not literal strings
• [SYNPY-1109] - unparseable synapse cacheMap raises JSONDecodeError
• [SYNPY-1110] - Cleanup on Windows console login
• [SYNPY-1112] - Concurrent migration of entities sharing the same file handle can result in an error
• [SYNPY-1114] - Mitigate new Rust compiler dependency on Linux via transitive cryptography dependency
• [SYNPY-1118] - Migration tool erroring when it shouldn’t

New Features

• [SYNPY-1058] - Accept oauth access token for authentication to use Synapse REST services
• [SYNPY-1103] - Multipart copy integration
• [SYNPY-1111] - Add function to get user certification status

Improvements

• [SYNPY-885] - Public interface to customize CACHE_ROOT_DIR
• [SYNPY-1102] - syncToSynapse adds empty annotation values
• [SYNPY-1104] - Python 3.9 support
• [SYNPY-1119] - Add source storage location option to storage migrate functions

v2.2.2

Highlights

• This version addresses an issue with downloads being retried unsuccessfully after encountering certain types of errors.
• A create_snapshot_version function is added for making table and view snapshots.

Bugs

• [SYNPY-1096] - Fix link to Synapse on PyPI
• [SYNPY-1097] - downloaded files are reset when disk space exhausted

New Features

• [SYNPY-1041] - Snapshot feature and programmatic clients

Improvements

• [SYNPY-1063] - Consolidate builds to GitHub Actions
• [SYNPY-1099] - Replace usage of deprecated PUT /entity/{id}/version endpoint

v2.2.0

Highlights

• Files that are part of syncFromSynapse and syncToSynapse operations (synapse get -r and synapse sync in the command line client, respectively) are transferred in in parallel threads rather than serially, substantially improving the performance of these operations.
• Table metadata from synapse get -q is automatically downloaded to a users working directory instead of to the Synapse cache (a hidden folder).
• Users can now pass their API key to synapse login in place of a password.

Bugs

• [SYNPY-1082] - Downloading entity linked to URL fails: module ‘urllib.parse’ has no attribute ‘urlretrieve’

Improvements

• [SYNPY-1072] - Improve throughput of multiple small file transfers
• [SYNPY-1073] - Parellelize upload syncs
• [SYNPY-1074] - Parallelize download syncs
• [SYNPY-1084] - Allow anonymous usage for public APIs like GET /teamMembers/{id}
• [SYNPY-1088] - Manifest is in cache with synapse get -q
• [SYNPY-1090] - Command line client does not support apikey

Tasks

• [SYNPY-1080] - Remove Versionable from SchemaBase
• [SYNPY-1085] - Move to pytest testing framework
• [SYNPY-1087] - Improve synapseclient installation instructions

v2.1.1

Highlights

• This version includes a performance improvement for syncFromSynapse downloads of deep folder hierarchies to local filesystem locations outside of the Synapse cache.

• Support is added for SubmissionViews that can be used to query and edit a set of submissions through table services.

  from synapseclient import SubmissionViewSchema
  project = syn.get("syn123")
  evaluation_id = '9876543'
  view = syn.store(SubmissionViewSchema(name='My Submission View', parent=project, scopes=[evaluation_id]))
  view_table = syn.tableQuery(f"select * from {view.id}")
  

Bug

• [SYNPY-1075] - Error in Python test (submission annotations
• [SYNPY-1076] - Upgrade/fix Pandas dependency

Improvement

• [SYNPY-1070] - Add support for submission views
• [SYNPY-1078] - Improve syncFromSynapse performance for large folder structures synced to external paths