Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vdk-jupyter: add iPython extension #1482

Closed
wants to merge 13 commits into from

Conversation

duyguHsnHsn
Copy link
Collaborator

What:
Add VDK iPython extension which using the StandaloneDataJob class loads job_input variable to a notebook. The job_input is created for the data job that the user specifies for example with giving the path to the job's parent directory.
You can see the README file to see how the extension is used.

Why: It is an essential feature for the Jupyter Integration

Tests: unit tests are introduced

Signed-off-by: Duygu Hasan [email protected]

@antoniivanov
Copy link
Collaborator

antoniivanov commented Jan 6, 2023

essential feature for the Jupyter Integration

This says nothing really. I hope you can see that. Why is it essential? Who is the user persona and how they'd use it and why it would be useful for them.

To use the extension it must be firstly installed with pip as a python package.
Then to load the extension in Jupyter the user should use:
```
%reload_ext vdk_ipython_ext
Copy link
Collaborator

Choose a reason for hiding this comment

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

would it not look a bit nicer if it was just %reload_ext vdk

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

In this way I get some errors with the imports and I thing it would be good to have a little difference since it is not loading the whole vdk but only a small part of it


The CI/CD is separated in two stages, a build stage and a release stage.
The build stage is made up of a few jobs, all which inherit from the same
job configuration and only differ in the Python version they use (3.7, 3.8, 3.9 and 3.10).
Copy link
Collaborator

Choose a reason for hiding this comment

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

you are missing 3.11 here

# Define entry point called "vdk.plugin.run" with name of plugin and module to act as entry point.
entry_points={"vdk.plugin.run": ["ipython-ext = vdk_ipython_ext"]},
classifiers=[
"Development Status :: 4 - Beta",
Copy link
Collaborator

Choose a reason for hiding this comment

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

It should be pre-alpha or alpha at most at the current stage - https://github.com/vmware/versatile-data-kit/wiki/Coding-Standard#development-status

dependabot bot and others added 9 commits January 6, 2023 13:20
Bumps [graphql-java-extended-scalars](https://github.com/graphql-java/graphql-java-extended-scalars) from 19.1 to 20.0.
- [Release notes](https://github.com/graphql-java/graphql-java-extended-scalars/releases)
- [Commits](graphql-java/graphql-java-extended-scalars@19.1...20.0)

---
updated-dependencies:
- dependency-name: com.graphql-java:graphql-java-extended-scalars
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [byte-buddy](https://github.com/raphw/byte-buddy) from 1.12.19 to 1.12.20.
- [Release notes](https://github.com/raphw/byte-buddy/releases)
- [Changelog](https://github.com/raphw/byte-buddy/blob/master/release-notes.md)
- [Commits](raphw/byte-buddy@byte-buddy-1.12.19...byte-buddy-1.12.20)

---
updated-dependencies:
- dependency-name: net.bytebuddy:byte-buddy
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Antoni Ivanov <[email protected]>
Bumps [nimbus-jose-jwt](https://bitbucket.org/connect2id/nimbus-jose-jwt) from 9.25.6 to 9.27.
- [Changelog](https://bitbucket.org/connect2id/nimbus-jose-jwt/src/master/CHANGELOG.txt)
- [Commits](https://bitbucket.org/connect2id/nimbus-jose-jwt/branches/compare/9.27..9.25.6)

---
updated-dependencies:
- dependency-name: com.nimbusds:nimbus-jose-jwt
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: ivakoleva <[email protected]>
…trol-service/projects/pipelines_control_service (#1475)

* build(deps): bump mockito-core

Bumps [mockito-core](https://github.com/mockito/mockito) from 4.10.0 to 4.11.0.
- [Release notes](https://github.com/mockito/mockito/releases)
- [Commits](mockito/mockito@v4.10.0...v4.11.0)

---
updated-dependencies:
- dependency-name: org.mockito:mockito-core
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Antoni Ivanov <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* vdk-jobs-troubleshooting: Add thread-dump utility

This change adds the implementation of a thread-dump utility to the
vdk-jobs-troubleshooting plugin.

The utility uses an http server, through which an administrator is able
to force a stacktrace dump of all threads used by the python process of
the data job. The server is bound to a port on the localhost, so to get
the stacktrace, one needs to be attached to the data job pod.

Testing Done: Added unit tests for the utility registry, and tested the
plugin itself locally by running a simple data job and examining the
execution logs.

Signed-off-by: Andon Andonov <[email protected]>

* vdk-jobs-troubleshooting: Add functional test

Add functional test.
Minor code refactoring.

Signed-off-by: Dako Dakov <[email protected]>

* vdk-jobs-troubleshooting: Address review feedback

Add documentation.
Remove redundant Optional type.

Signed-off-by: Dako Dakov <[email protected]>

* vdk-jobs-troubleshooting: remove unused import

Remove unused import.

Signed-off-by: Dako Dakov <[email protected]>

* vdk-jobs-troubleshooting: remove unused import

Remove unused import.

Signed-off-by: Dako Dakov <[email protected]>

* vdk-jobs-troubleshooting: Address review feedback

Remove redundancies.

Signed-off-by: Dako Dakov <[email protected]>

Signed-off-by: Andon Andonov <[email protected]>
Signed-off-by: Dako Dakov <[email protected]>
Co-authored-by: ddakov <[email protected]>
Release the plugin.

Signed-off-by: Dako Dakov <[email protected]>

Signed-off-by: Dako Dakov <[email protected]>
Bumps [nimbus-jose-jwt](https://bitbucket.org/connect2id/nimbus-jose-jwt) from 9.27 to 9.28.
- [Changelog](https://bitbucket.org/connect2id/nimbus-jose-jwt/src/master/CHANGELOG.txt)
- [Commits](https://bitbucket.org/connect2id/nimbus-jose-jwt/branches/compare/9.28..9.27)

---
updated-dependencies:
- dependency-name: com.nimbusds:nimbus-jose-jwt
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Antoni Ivanov <[email protected]>
@duyguHsnHsn duyguHsnHsn closed this Jan 6, 2023
@duyguHsnHsn
Copy link
Collaborator Author

Closing this PR bc it is a duplicate of #1483
and deleting the branch

@duyguHsnHsn duyguHsnHsn deleted the person/hduygu/vdk-ipython-ext branch January 6, 2023 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants