v4.8.0

Highlights

• Introduced new object-oriented models for working with Synapse Datasets, DatasetCollections, EntityViews, MaterializedViews, and SubmissionViews. This includes tutorials for each of these models.
• Improved handling of progress bars, logging, and error messages
• Added support for Python 3.13
• Patch CWE-444

Features

• [SYNPY-1571] Adds Dataset Model & Introduces Composition Model for Table/View-like Classes by @BWMac in #1175
• [SYNPY-1575] Introduce EntityView model by @BryanFauble in #1181
• [SYNPY-1579] Introduce the materialized view by @BryanFauble in #1190
• [SYNPY-1578] DatasetCollection OOP Model by @BWMac in #1189
• [SYNPY-1577] Submission View by @BryanFauble in #1192

Bug Fixes

• [SYNPY-1547] parentWikiId="" Bug by @BWMac in #1165
• [SYNPY-1553] Update to support python 3.13 by @BryanFauble in #1171
• [SYNPY-1575] Correct regular expression for invalid column name by @BryanFauble in #1187
• [SYNPY-1584] Add a buffer.tell when truncating bytes during dataframe upload and drop writing header to csv by @BryanFauble in #1193

Tech Debt

• [SYNPY-1488] Patch nested tqdm progress bars and messages to logger by @BryanFauble in #1177
• [SYNPY-1551] Tables refactor by @BryanFauble in #1151
• [SYNPY-1497] refactored version check to use Pypi for version info by @andrewelamb in #1191

Other

• Update the docstring for setPermissions to be clearer by @BryanFauble in #1164
• Update Dockerfile - Fixes pandas installation by @BWMac in #1169
• [SYNPY-1570, SYNPY-1555] Support passing user_agent to the Synapse class constructor, and HTTPX Library usage by @BryanFauble in #1170
• Prevent concurrent builds per branch by @BryanFauble in #1178
• [DPE-1253] Add PR template for GH Pull requests by @BryanFauble in #1182
• [SYNPY-1542] Upgrade readthedocs os, python version, and search ranking by @BryanFauble in #1184
• [SYNPY-1553] Removes Blank Auth Header by @BWMac in #1185
• Include a default timeout for HTTP requests library to 70 seconds by @BryanFauble in #1188
• Add table and file versioning tutorial updates by @rxu17 in #1172
• Updates dataset tutorial to fix typo by @BWMac in #1186
• Create SECURITY.md by @thomasyu888 in #1166

New Contributors

• @andrewelamb made their first contribution in #1191

Full Changelog: v4.7.0...v4.8.0-rc

v4.8.0-rc

Highlights

• Introduced new object-oriented models for working with Synapse Datasets, DatasetCollections, EntityViews, MaterializedViews, and SubmissionViews. This includes tutorials for each of these models.
• Improved handling of progress bars, logging, and error messages
• Added support for Python 3.13

Features

• [SYNPY-1571] Adds Dataset Model & Introduces Composition Model for Table/View-like Classes by @BWMac in #1175
• [SYNPY-1575] Introduce EntityView model by @BryanFauble in #1181
• [SYNPY-1579] Introduce the materialized view by @BryanFauble in #1190
• [SYNPY-1578] DatasetCollection OOP Model by @BWMac in #1189
• [SYNPY-1577] Submission View by @BryanFauble in #1192

Bug Fixes

• [SYNPY-1547] parentWikiId="" Bug by @BWMac in #1165
• [SYNPY-1553] Update to support python 3.13 by @BryanFauble in #1171
• [SYNPY-1575] Correct regular expression for invalid column name by @BryanFauble in #1187
• [SYNPY-1584] Add a buffer.tell when truncating bytes during dataframe upload and drop writing header to csv by @BryanFauble in #1193

Tech Debt

• [SYNPY-1488] Patch nested tqdm progress bars and messages to logger by @BryanFauble in #1177
• [SYNPY-1551] Tables refactor by @BryanFauble in #1151
• [SYNPY-1497] refactored version check to use Pypi for version info by @andrewelamb in #1191

Other

• Update the docstring for setPermissions to be clearer by @BryanFauble in #1164
• Update Dockerfile - Fixes pandas installation by @BWMac in #1169
• [SYNPY-1570, SYNPY-1555] Support passing user_agent to the Synapse class constructor, and HTTPX Library usage by @BryanFauble in #1170
• Prevent concurrent builds per branch by @BryanFauble in #1178
• [DPE-1253] Add PR template for GH Pull requests by @BryanFauble in #1182
• [SYNPY-1542] Upgrade readthedocs os, python version, and search ranking by @BryanFauble in #1184
• [SYNPY-1553] Removes Blank Auth Header by @BWMac in #1185
• Include a default timeout for HTTP requests library to 70 seconds by @BryanFauble in #1188
• Add table and file versioning tutorial updates by @rxu17 in #1172
• Updates dataset tutorial to fix typo by @BWMac in #1186
• Create SECURITY.md by @thomasyu888 in #1166

New Contributors

• @andrewelamb made their first contribution in #1191

Full Changelog: v4.7.0...v4.8.0-rc

v4.7.0

Highlights

• Added functionality for interacting with Synapse Agents:
  • The new Agent OOP model allows you to chat with the baseline Synapse Agent,
    register and chat with custom Synapse Agents, manage multiple chat sessions and more.
  • See the Agent documentation for more details and example code to get started.

What's Changed

• [SYNPY-1544] Synapse Agent OOP Model by @BWMac in #1152
• [SYNPY-1544] Fixes docstring by @BWMac in #1155
• Removes example setting annotations with Agent class by @BWMac in #1156
• [SYNPY-1557] Sync a Linked Folder Bug by @BWMac in #1157
• [SYNPY-1544] Return the AgentPrompt when calling the prompt function by @BryanFauble in #1158

Full Changelog: v4.6.1...v4.7.0

v4.6.1

What's Changed

• Update misaligned script by @thomasyu888 in #1144
• [SYNPY-1423] update mkdocstrings dependency for 1.8.0 by @danlu1 in #1145
• Add procps to Dockerfile to enable use of container in Nextflow by @adamjtaylor in #1146
• [SYNPY-1548] Swap to a FIFO queue by @BryanFauble in #1147

New Contributors

• @adamjtaylor made their first contribution in #1146

Full Changelog: v4.6.0...v4.6.1-rc

v4.6.0

Highlights

• Patching an issue present in 4.5.1 that broke downloads from google bucket files.
• Support for python 3.12
• Drop support for python 3.8

What's Changed

• [SYNPY-1521] Fixes asDataFrame kwarg Collision Issue by @BWMac in #1132
• [SYNPY-1520] Support python 3.12 by @BryanFauble in #1133
• [SYNPY-1517] Deprecate Python 3.8 Support by @BWMac in #1134
• [SYNPY-1524] Fixes ghcr-build-and-push-on-develop and ghcr-build-and-push-on-release Workflows by @BWMac in #1136
• [SYNPY-1524] Updates Dockerfile by @BWMac in #1137
• [SYNPY-1525] Verify expiration param in url by @BryanFauble in #1139
• [SYNPY-1513] Validate input submission ID in getSubmission(...) by @jaymedina in #1135
• [SYNPY-1522] Add note on lost shared libraries to install instructions for conda by @jaymedina in #1140

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

v4.5.1

4.5.1 (2024-09-19)

Highlights

• Telemetry auto instrumentation:
  • By employing the usage of the opentelemetry-python-contrib
    we are able to take advantage of the support for auto instrumenting several
    libraries in use by this client. This telemetry data is paramount for exceptional
    observability. Check out the readme for a quickstart.
• owner_id (Or the ID of the logged in profile) is available on logged in Synapse instance via syn.credentials.owner_id

What's Changed

• [FDS-2386] Add owner id to the credentials to be used later on by @BryanFauble in #1130
• [FDS-2386] Global client caching, Telemetry auto instruementation by @BryanFauble in #1129

Full Changelog: v4.5.0...v4.5.1-rc

v4.5.0

Highlights

• Improved handling of pre-authorized requests:
  • During long running asynchronous download operations (i.e. syncing a folder with many files),
    some pre-authorized URLs were expiring before they were used to download the file. This
    change will now check the expiration datetime of the URL before using it.
    If the URL is expired it will be refreshed.
• Added support for pandas.read_csv keyword arguments:
  • Added support for all pandas.read_csv keyword arguments to the asDataFrame method of the CsvFileTable class.
  • This enables custom handling of missing values and default values when reading a Synapse table to a pandas DataFrame. See the pandas documentation for a full list of available keyword arguments.

What's Changed

• [SYNPY-1514] Handle Expired Pre-Signed URLs by @BWMac in #1126
• [SYNPY-1509] Updates NA handling for CSVFileTable.asDataFrame by @BWMac in #1127
• [FDS-2373] Update retry delay, add some otel traces, add retry to url creation by @BryanFauble in #1128

Full Changelog: v4.4.1...v4.5.0

v4.4.1

What's Changed

• Update file tutorial with missing line by @rxu17 in #1123
• [SYNPY-1436] avoid duplicate user profile call during login by @danlu1 in #1124
• [SYNPY-1511] Correct missing synapse client propogation and caching by @BryanFauble in #1125

New Contributors

• @rxu17 made their first contribution in #1123

Full Changelog: v4.4.0...v4.4.1-rc

v4.4.0

Highlights

• Downloading files stability improvements:
  • The download algorithm has been re-written to focus on stability, reliability,
    and performance.
  • Checkout the results of our benchmarking.
    Compared to v4.3.0 we are seeing a 10-50% decrease in overall transfer time for
    most test cases.
• New Docker containers every release:
  • Every production, release candidate, and develop release will create a new docker
    image available here
• Credentials passed by command line argument will now be evaluated before credentials
  stored in the ~/.synapseConfig file.

What's Changed

• [SYNPY-1341 & SYNPY-1479] Change syntax for conditional of ghcr release job by @jaymedina in #1102
• [SYNPY-1483] Update default order for credential provider by @BryanFauble in #1105
• [SYNPY-1482] Updating to remove loop executor during annotation store by @BryanFauble in #1104
• [SYNPY-1476] Splitting logic for downloading content from client.py by @BryanFauble in #1103
• [SYNPY-1485] feat: added isort to pre-commit hook by @linglp in #1108
• [SYNPY-1485] Running pre-commit on all files to run isort by @BryanFauble in #1109
• [SYNPY-1447] Update fillna method to work directly off original df by @jaymedina in #1113
• [SYNPY-1457] Fix deprecated Node.js build warnings by @jaymedina in #1112
• [SYNPY-1487] Fix missing coverage report by @jaymedina in #1114
• [SYNPY-1476] Refactoring multithreaded downloads to be more fault tolerant by @BryanFauble in #1107
• [SYNPY-1490] Merge develop into master by @BryanFauble in #1116
• [SYNPY-1494] Remove process pool executor by @BryanFauble in #1117
• Update os matrix for check-deploy by @BryanFauble in #1118
• [SYNPY-1476] Skip reading response content on error by @BryanFauble in #1119
• [SYNPY-1504] Remove download_location from File and rely only on Path by @BryanFauble in #1120

Full Changelog: v4.3.1...v4.4.0

v4.3.1

Bug Fixes

• [SYNPY-1494] - loky crashed uwsgi process in schematic manifest submission

Full Changelog: v4.3.0...v4.3.1-rc