Skip to content

Add a notebook optional dependency extra #161

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.

Sign up for GitHub

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

Open
njzjz-bot wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a notebook optional dependency extra #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,11 @@ Please refer to test files for detailed usage.
- JSON encoder for `Argument` and `Variant` classes
- Generate [JSON schema](https://json-schema.org/) from an `Argument`, which can be further integrated with JSON editors such as [Visual Studio Code](https://code.visualstudio.com/)
- Load dict values from external JSON/YAML files via the `$ref` key

## Notebook support

Install the optional IPython dependency before importing `dargs.notebook`:

```bash
python -m pip install "dargs[notebook]"
```
3 changes: 3 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ documentation = "https://docs.deepmodeling.com/projects/dargs"
repository = "https://github.com/deepmodeling/dargs"

[project.optional-dependencies]
notebook = [
"ipython",
]
test = [
"ipython",
"jsonschema",
Expand Down
Loading