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

Make notebook tester into package #1208

Merged
merged 10 commits into from
Apr 24, 2024
Merged

Make notebook tester into package #1208

merged 10 commits into from
Apr 24, 2024

Conversation

frankharkins
Copy link
Member

@frankharkins frankharkins commented Apr 19, 2024

Makes the notebook tester into an installable package so we can re-use it in other repos.

Main changes are:

  • Adding pyproject.toml and moving script to qiskit_docs_notebook_tester/__init__.py
  • Moving the lists of notebooks to a config file
  • Splitting the requirements needed for running the code in the notebooks form those neeed by the testing script itself

The interface via tox should be unaffected.

@frankharkins frankharkins marked this pull request as ready for review April 19, 2024 17:38
Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

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

Nice!

scripts/nb-tester/notebooks.toml Outdated Show resolved Hide resolved
scripts/nb-tester/pyproject.toml Outdated Show resolved Hide resolved
scripts/nb-tester/qiskit_docs_notebook_tester/__init__.py Outdated Show resolved Hide resolved
tox.ini Show resolved Hide resolved
tox.ini Show resolved Hide resolved
scripts/nb-tester/pyproject.toml Show resolved Hide resolved
Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

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

Thanks! Readme needs to be updated with new instructions for updating the TOML file when you have a notebook that submits jobs

raise ValueError(
f"Couldn't read config from {path}; check it exists and the"
" entries are correct."
) from err
Copy link
Collaborator

Choose a reason for hiding this comment

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

nice use of from err!

@frankharkins frankharkins added this pull request to the merge queue Apr 24, 2024
Merged via the queue into main with commit eabb687 Apr 24, 2024
2 checks passed
@frankharkins frankharkins deleted the FH/packagify-nb-tester branch April 24, 2024 15:18
frankharkins added a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Makes the notebook tester into an installable package so we can re-use
it in other repos.

Main changes are:
* Adding `pyproject.toml` and moving script to
`qiskit_docs_notebook_tester/__init__.py`
* Moving the lists of notebooks to a config file
* Splitting the requirements needed for running the code in the
notebooks form those neeed by the testing script itself

The interface via `tox` should be unaffected.

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants