Create tox configuration, update README accordingly.
This commit is contained in:
parent
20c74954a5
commit
309f89d413
34
README.md
34
README.md
@ -19,28 +19,28 @@ heavy leverage of numpy for number crunching, Qt's GraphicsView framework for
|
||||
Requirements
|
||||
------------
|
||||
|
||||
* PyQt 4.7+, PySide, PyQt5, or PySide2
|
||||
* python 2.7, or 3.x
|
||||
* NumPy
|
||||
* For 3D graphics: pyopengl and qt-opengl
|
||||
* Known to run on Windows, Linux, and Mac.
|
||||
* PyQt 4.7+, PySide, PyQt5, or PySide2
|
||||
* python 2.7, or 3.x
|
||||
* NumPy
|
||||
* For 3D graphics: pyopengl and qt-opengl
|
||||
* Known to run on Windows, Linux, and Mac.
|
||||
|
||||
Support
|
||||
-------
|
||||
|
||||
* Report issues on the [GitHub issue tracker](https://github.com/pyqtgraph/pyqtgraph/issues)
|
||||
* Post questions to the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph) or [StackOverflow](https://stackoverflow.com/questions/tagged/pyqtgraph)
|
||||
* Report issues on the [GitHub issue tracker](https://github.com/pyqtgraph/pyqtgraph/issues)
|
||||
* Post questions to the [mailing list / forum](https://groups.google.com/forum/?fromgroups#!forum/pyqtgraph) or [StackOverflow](https://stackoverflow.com/questions/tagged/pyqtgraph)
|
||||
|
||||
Installation Methods
|
||||
--------------------
|
||||
|
||||
* From pypi:
|
||||
- Last released version: `pip install pyqtgraph`
|
||||
- Latest development version: `pip install git+https://github.com/pyqtgraph/pyqtgraph`
|
||||
* From PyPI:
|
||||
* Last released version: `pip install pyqtgraph`
|
||||
* Latest development version: `pip install git+https://github.com/pyqtgraph/pyqtgraph`
|
||||
* To install system-wide from source distribution: `python setup.py install`
|
||||
* Many linux package repositories have release versions.
|
||||
* To use with a specific project, simply copy the pyqtgraph subdirectory
|
||||
anywhere that is importable from your project.
|
||||
anywhere that is importable from your project.
|
||||
* For installation packages, see the website (pyqtgraph.org)
|
||||
|
||||
Documentation
|
||||
@ -50,3 +50,15 @@ The easiest way to learn pyqtgraph is to browse through the examples; run `pytho
|
||||
|
||||
The official documentation lives at http://pyqtgraph.org/documentation
|
||||
|
||||
Testing
|
||||
-------
|
||||
|
||||
To test the pyqtgraph library, clone the repository, and run `pytest pyqtgraph`. For more thurough testing, you can use `tox`, however the [tox-conda](https://github.com/tox-dev/tox-conda) plugin is required. Running `tox` on its own will run `pytest pyqtgraph -vv` on it's own, however if you want to run a specific test, you can run `tox -- pyqtgraph/exporters/tests/test_svg::test_plotscene` for example.
|
||||
|
||||
Dependencies include:
|
||||
|
||||
* pytest
|
||||
* pytest-cov
|
||||
* pytest-xdist
|
||||
* tox
|
||||
* tox-conda
|
46
tox.ini
Normal file
46
tox.ini
Normal file
@ -0,0 +1,46 @@
|
||||
[tox]
|
||||
envlist =
|
||||
; qt 5.12.x
|
||||
py{27,37}-pyside2-pip
|
||||
; qt 5.12.x
|
||||
py{35,37}-pyqt5-pip
|
||||
; qt 5.9.7
|
||||
py{27,37}-pyqt5-conda
|
||||
; qt 5.6.2
|
||||
py35-pyqt5-conda
|
||||
; qt 5.6.2
|
||||
py{27,35,37}-pyside2-conda
|
||||
; pyqt 4.11.4 / qt 4.8.7
|
||||
py{27,36}-pyqt4-conda
|
||||
; pyside 1.2.4 / qt 4.8.7
|
||||
py{27,36}-pyside-conda
|
||||
|
||||
[base]
|
||||
deps =
|
||||
pytest
|
||||
numpy
|
||||
scipy
|
||||
pyopengl
|
||||
flake8
|
||||
six
|
||||
coverage
|
||||
|
||||
[testenv]
|
||||
deps=
|
||||
{[base]deps}
|
||||
pytest-cov
|
||||
pytest-xdist
|
||||
pyside2-pip: pyside2
|
||||
pyqt5-pip: pyqt5
|
||||
|
||||
conda_deps=
|
||||
pyside2-conda: pyside2
|
||||
pyside-conda: pyside
|
||||
pyqt5-conda: pyqt
|
||||
pyqt4-conda: pyqt=4
|
||||
|
||||
conda_channels=
|
||||
conda-forge
|
||||
commands=
|
||||
python -c "import pyqtgraph as pg; pg.systemInfo()"
|
||||
python -m pytest {posargs:pyqtgraph -svv}
|
Loading…
Reference in New Issue
Block a user