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

Update README #156

Open
wants to merge 1 commit 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
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,15 @@ Outputs:

```py
test.py:4 <module>:
whatever: [1, 2, 3] (list)
whatever: [1, 2, 3] (list) len=3
```


That's only the tip of the iceberg, for example:

```py
import numpy as np
from devtools import debug

data = {
'foo': np.array(range(20)),
Expand All @@ -58,8 +59,8 @@ outputs:

## Usage without Import

devtools can be used without `from devtools import debug` if you add `debug` into `__builtins__`
devtools can be used without `from devtools import debug` if you add `debug` into `builtins`
in `sitecustomize.py`.

For instructions on adding `debug` to `__builtins__`,
For instructions on adding `debug` to `builtins`,
see the [installation docs](https://python-devtools.helpmanual.io/usage/#usage-without-import).
Binary file modified demo.py.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading