Skip to content

[MCC-1500745] Python Lib - Create Usage Jupyter file for Client#41

Merged
nmakarava-mdsol merged 2 commits into
mainfrom
feat/MCC-1487235_jup
May 26, 2026
Merged

[MCC-1500745] Python Lib - Create Usage Jupyter file for Client#41
nmakarava-mdsol merged 2 commits into
mainfrom
feat/MCC-1487235_jup

Conversation

@ibaig-mdsol

Copy link
Copy Markdown
Contributor

feature

Checklist

  • Review the pull request to fix typos and ensure variable/function names are intuitive, etc.
  • Make sure the pull request does not have excessive number of unnecessary commits. Utilize the git commit --amend --no-edit command to reduce commit messages when making small file changes (like changing linespacing).
  • Make sure you have added unit tests for the code changes. Tests should be added in the tests/ folder.
  • Modify docs, if required. Add any new documentation in the doc/ folder.
  • Rebase on latest active development branch (develop/main).

Changes Summary

  • Added jupyter file for usage
  • Also added setup and quick start guides
  • Added release.yml for releasing package workflow (part of MCC-1489337 )

Deployment Notes

N/A

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds end-user guidance and examples for using the DataConnect Python library, plus a GitHub Actions workflow intended to automate package releases.

Changes:

  • Added a usage Jupyter notebook demonstrating common client operations (list studies, search datasets, fetch data, publish).
  • Added setup and quick start markdown guides for first-time users.
  • Added a release.yml workflow to build and create GitHub releases/tags.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
guides/dataconnect_usage.ipynb New end-to-end usage notebook (connect, query, transform, publish).
guides/dataconnect_setup.md New environment/setup instructions for installing and running the notebook.
guides/dataconnect_quickstart.md New quick-start steps and a minimal standalone code sample.
.gitignore Attempts to un-ignore the committed usage notebook while ignoring other notebooks.
.github/workflows/release.yml New release automation workflow (build, changelog generation, GitHub Release creation).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread guides/dataconnect_setup.md Outdated
Comment thread guides/dataconnect_setup.md
Comment thread .github/workflows/release.yml
Comment thread guides/dataconnect_usage.ipynb Outdated
Comment thread guides/dataconnect_usage.ipynb Outdated
Comment thread guides/dataconnect_usage.ipynb Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.

Comment thread guides/dataconnect_setup.md
Comment thread guides/dataconnect_usage.ipynb
Comment thread guides/dataconnect_usage.ipynb
Comment thread .github/workflows/release.yml
Comment thread .github/workflows/release.yml
@nmakarava-mdsol nmakarava-mdsol merged commit b78a219 into main May 26, 2026
4 checks passed
@ibaig-mdsol ibaig-mdsol deleted the feat/MCC-1487235_jup branch June 8, 2026 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants