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

📚 DOCS: Remove prompt for command without output #32

Merged
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
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,23 +49,23 @@ regenerate the notebooks, saving the new outputs.
To install from [Conda](https://docs.conda.io) (recommended):

```shell
>> conda install -c conda-forge pytest-notebook
conda install -c conda-forge pytest-notebook
```

To install *via* [pip](https://pypi.org/project/pip/) from [PyPI](https://pypi.org/project):

```shell
>> pip install pytest-notebook
pip install pytest-notebook
```

To install the development version:

```shell
>> git clone https://github.com/chrisjsewell/pytest-notebook .
>> cd pytest-notebook
>> pip install --upgrade pip
>> pip install -e .
>> # pip install -e .[code_style,testing,docs] # install extras for more features
git clone https://github.com/chrisjsewell/pytest-notebook .
cd pytest-notebook
pip install --upgrade pip
pip install -e .
# pip install -e .[code_style,testing,docs] # install extras for more features
```

## Usage
Expand All @@ -75,18 +75,18 @@ See the documentation at: http://pytest-notebook.readthedocs.io/
If you want to test some sample notebooks, add the `--nb-test-files` flag:

```shell
>> git clone https://github.com/chrisjsewell/pytest-notebook
>> cd pytest-notebook/examples
>> pip install pytest ipykernel pytest-notebook
>> pytest --nb-test-files *.ipynb
git clone https://github.com/chrisjsewell/pytest-notebook
cd pytest-notebook/examples
pip install pytest ipykernel pytest-notebook
pytest --nb-test-files *.ipynb
```

You should see `success.ipynb` passed the test and `fail.ipynb` failed the test.

You can regenerate the outputs of `fail.ipynb` with the `--nb-force-regen` flag:

```shell
>> pytest --nb-test-files --nb-force-regen *.ipynb
pytest --nb-test-files --nb-force-regen *.ipynb
```

## Contributing
Expand All @@ -96,8 +96,8 @@ Contributions are very welcome.
The following will discover and run all unit test:

```shell
>> pip install -e .[testing]
>> pytest -v
pip install -e .[testing]
pytest -v
```

### Coding Style Requirements
Expand All @@ -112,15 +112,15 @@ and testing for lint errors before submitting a commit.
It can be setup by:

```shell
>> cd pytest-notebook
>> pre-commit install
cd pytest-notebook
pre-commit install
```

Optionally you can run `black` and `flake8` separately:

```shell
>> black .
>> flake8 .
black .
flake8 .
```

Editors like VS Code also have automatic code reformat utilities, which can adhere to this standard.
Expand Down