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 and demo images #60

Merged
merged 1 commit into from
Dec 1, 2023
Merged
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
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ The minimum Python version is 3.10
## Demo

### With hot reloading
Slower initial start time but faster subsequent runs
Faster subsequent runs

![Hot reloading demo](docs/hot-reloading-demo.gif)
![Hot reloading demo](docs/with-daemon.gif)

### Without hot reloading
![Not hot reloading demo](docs/not-hot-reloading-demo.gif)
![Not hot reloading demo](docs/no-daemon.gif)

## Installation
Do not install in production code. This is exclusively for the developer environment.
Expand All @@ -54,12 +54,11 @@ When running pytest, the plugin will detect whether the daemon is running.
If the daemon is not running, it will error unless the `--daemon-start-if-needed` argument is passed.

The current version of the VS Code Python extension is not, by default, compatible with automatically starting the daemon. The
test runner will hang. However, you can revert to legacy behavior which will allow for using the automatic starting.
test runner will hang. However, you can revert to legacy behavior which will allow for using the automatic starting.
See the VS Code section below for more information.

The recommended way to run the daemon is to give it its own run run profile so you can easily use the debugger in tests. As a convenience
you can also, if you're using a dev container, add this to your postStartCommand: `pytest --daemon &`. If it doesn't seem
to work, see: https://github.com/microsoft/vscode-remote-release/issues/8536
you can also, if you're using a dev container, add this to your postStartCommand: `pytest --daemon &`. If the daemon doesn't start from your postStartCommand, see: https://github.com/microsoft/vscode-remote-release/issues/8536

Note that a pid file is created to track the pid.

Expand Down
Binary file removed docs/hot-reloading-demo.gif
Binary file not shown.
Binary file added docs/no-daemon.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/not-hot-reloading-demo.gif
Binary file not shown.
Binary file added docs/with-daemon.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.