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

Alex treebeard patch 3 #125

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: ''

---

> [!Note]
> [!Note]
> It may be quicker to check in with us on [Discord](https://discord.gg/QFjCpMjqRY) before logging your issue


Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: ''

---

> [!Note]
> [!Note]
> It may be quicker to check in with us on [Discord](https://discord.gg/QFjCpMjqRY) before logging your issue

**Is your feature request related to a problem? Please describe.**
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
**Why?** To raise the quality of scientific material through better automation

**Who is this for?** Research/Machine Learning Software Engineers who maintain packages/teaching materials with documentation written in notebooks.

s
---
**✨ New: save your energy when investigating GitHub actions failures with our [Pull Request Bot](https://github.com/marketplace/treebeard-build)**

---

## Functionality
## Functionalitytest

1. Executes notebooks using pytest and nbclient, allowing parallel notebook testing
2. Optionally writes back to the repo, allowing faster building of [nbsphinx](https://github.com/spatialaudio/nbsphinx) or [jupyter book](https://github.com/executablebooks/jupyter-book) docs
Expand All @@ -31,7 +31,7 @@ pip install pytest nbmake
pytest --nbmake **/*ipynb
```

## Configure Cell Timeouts
## Configure Cell Tsddfdsimeouts

You can configure the cell timeout with the following pytest flag:

Expand Down
15 changes: 14 additions & 1 deletion src/nbmake/pytest_plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
from pathlib import Path
from typing import Any, Optional

from pytest import ExitCode

from .pytest_items import NotebookFile


Expand Down Expand Up @@ -73,4 +75,15 @@ def pytest_terminal_summary(terminalreporter: Any, exitstatus: int, config: Any)
# this message can be disabled with pytest --no-summary
# but let us know if it is annoying you
# ...we can also print diagnostics/stats here -- requests welcome
print(f"\nLearn more about nbmake at https://github.com/treebeardtech/nbmake\n")
try:
if os.environ.get("GITHUB_ACTIONS", False):
if exitstatus == ExitCode.TESTS_FAILED:
print(
f"\n* Automate reading GitHub Actions logs with our bot: https://github.com/marketplace/treebeard-build\n"
)
else:
print(
f"\nLearn more about nbmake at https://github.com/treebeardtech/nbmake\n"
)
except:
pass
3 changes: 1 addition & 2 deletions tests/resources/a_test.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@

def test_x():
assert True
assert True
Loading