Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeyespo/flask-pytest
Runs pytest in a background process when DEBUG is True.
https://github.com/joeyespo/flask-pytest
Last synced: 16 days ago
JSON representation
Runs pytest in a background process when DEBUG is True.
- Host: GitHub
- URL: https://github.com/joeyespo/flask-pytest
- Owner: joeyespo
- License: isc
- Created: 2015-08-23T19:32:49.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-10-21T23:30:18.000Z (about 5 years ago)
- Last Synced: 2024-10-14T09:29:11.793Z (about 1 month ago)
- Language: Python
- Size: 11.7 KB
- Stars: 28
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
Flask-pytest
============
[](http://pypi.python.org/pypi/flask-pytest)
Runs pytest in a background process when `DEBUG` is `True`.
Motivation
----------
Running tests shouldn't be something you have to go out of your way to do. With
this Flask extension, the tests will be automatically be run for you, and
re-run when code changes.
Installation
------------
```bash
$ pip install flask-pytest
```
Usage
-----
Add `app = FlaskPytest(app)` to your project:
```python
from flask import Flask
from flask.ext.pytest import FlaskPytest
app = Flask(__name__)
app.config.from_pyfile('settings.py')
app = FlaskPytest(app) # <-- Add this line
@app.route('/')
def hello():
return 'Hello World!'
app.run()
```
##### settings.py
```python
DEBUG = True
```
Your tests will now be run in the background:
```bash
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with reloader
Running tests...
...
3 passed in 1.20 seconds
```
If a test fails, you'll hear a beep and see the output. Change a source file to
reload the development server like normal, which will now re-run the tests.
Configuration
-------------
Flask-pytest runs out-of-the-box without any config. However, you may want to
tweak the behavior here and there. Here's a list of available settings you can
add to your `app.config`:
- `FLASK_PYTEST_ENABLED`: Set to `True` to run tests regardless of `DEBUG`, or
to `False` to disable the extension entirely. If `None`, the extension will
run when `DEBUG` is `True`. Default: `None`
- `FLASK_PYTEST_BEEP`: Beep when pytest returns a non-zero exit code. Default: `True`
- `FLASK_PYTEST_EXITFIRST`: Stops running tests if a test fails. Default: `True`
- `FLASK_PYTEST_QUIET`: Runs pytest in quiet mode. Default: `True`
Contributing
------------
1. Check the open issues or open a new issue to start a discussion around
your feature idea or the bug you found
2. Fork the repository, make your changes, and add yourself to [Authors.md](AUTHORS.md)
3. Send a pull request
If your PR has been waiting a while, feel free to [ping me on Twitter](http://twitter.com/joeyespo).