Skip to content

Fix setup instructions, test requirements #26

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.

Sign up for GitHub

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

Merged
bmedx merged 1 commit into from
Feb 4, 2019
Merged

Fix setup instructions, test requirements #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ quality: ## check coding style with pycodestyle and pylint

requirements: ## install development environment requirements
pip install -qr requirements/pip-tools.txt
pip-sync requirements/dev.txt requirements/private.*
pip-sync requirements/dev.txt requirements/test.txt requirements/private.*
pip install -e .

test: clean ## run tests in the current virtualenv
pytest
Expand Down
7 changes: 4 additions & 3 deletions docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ below is executed within the virtualenv.
.. _virtualenv: https://virtualenvwrapper.readthedocs.org/en/latest/


Install the tool
----------------
Install the requirements
------------------------
This will also install the Code Annotations package as editable, to allow access to the Stevedore plugins.

.. code-block:: bash
$ make requirements
$ pip install -e .
Run the tests
Expand Down