Skip to content

Commit

Permalink
Update commands for installing extra deps
Browse files Browse the repository at this point in the history
  • Loading branch information
ades authored and einarf committed Oct 13, 2023
1 parent 3dd685b commit 49b6d17
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 31 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ you provide us your `moderngl.Context`.
## Install

```bash
pip install moderngl-window
$ pip install moderngl-window
```

## Supported Platforms
Expand Down Expand Up @@ -67,13 +67,13 @@ Test.run()
Run the example with different window backends:

```bash
python test.py --window pyglet
python test.py --window pygame2
python test.py --window glfw
python test.py --window sdl2
python test.py --window pyside2
python test.py --window pyqt5
python test.py --window tk
$ python test.py --window pyglet
$ python test.py --window pygame2
$ python test.py --window glfw
$ python test.py --window sdl2
$ python test.py --window pyside2
$ python test.py --window pyqt5
$ python test.py --window tk
```

`WindowConfig` classes are the simplest way to get started without knowing
Expand All @@ -88,29 +88,28 @@ We assume the user knows how to handle virtualenvs.
# Install the package in editable mode
$ pip install -e .

# Set up and dev requirements
pip install -r requirements.txt
pip install -r tests/requirements.txt
# Install test and development requirements
$ pip install -e .[tests]
```

## Running Tests

Tests are set up with `tox` running pytest with coverage and flake8.

```bash
pip install -r tests/requirements.txt
tox -e py36
tox -e py37
tox -e py38
tox -e py39
tox -e pep8
$ pip install -e .[tests]
$ tox -e py36
$ tox -e py37
$ tox -e py38
$ tox -e py39
$ tox -e pep8
```

## Building Docs

```bash
pip install -r docs/requirements.txt
python setup.py build_sphinx
$ pip install -e .[docs]
$ sphinx-build -b html docs docs/_build
```

## Contributing
Expand Down
3 changes: 3 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,6 @@ docs =
sphinx-rtd-theme
sphinxcontrib-napoleon
doc8

[coverage:run]
source = moderngl_window
19 changes: 7 additions & 12 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,30 @@
[tox]
skipsdist = True
envlist =
py36
py37
py38
py39
py310
py311
pep8

[gh-actions]
python =
3.5: py35
3.6: py36
3.7: py37
3.8: py38
pep8: py38
3.9: py39
3.10: py310
3.11: py311

[testenv]
usedevelop = True
basepython =
py36: python3.6
py37: python3.7
py38: python3.8
py39: python3.9
py310: python3.10
py311: python3.11

deps =
-r{toxinidir}/requirements.txt
-r{toxinidir}/tests/requirements.txt
extras = tests
commands =
coverage run --source=moderngl_window -m pytest tests/
coverage run -m pytest tests/
coverage report

[testenv:pep8]
Expand Down

0 comments on commit 49b6d17

Please sign in to comment.