Skip to content

Commit 95e8ffe

Browse files
committed
Add test-deps target in the Makefile
This should make it easier to install the testing dependencies for new users. Re: discussion on sigmavirus24#65
1 parent ca53f84 commit 95e8ffe

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ travis:
1414

1515
tests: travis
1616

17+
test-deps:
18+
pip install -r requirements.txt
19+
1720
htmlcov: .coverage
1821
coverage html --omit=github3/packages/*
1922

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ Dependencies
2828
Testing
2929
~~~~~~~
3030

31+
You can run either ``pip install -r requirements.txt`` to install the
32+
following before testing or simply ``make test-deps``. It is suggested you do
33+
this in a virtual enviroment.
34+
3135
- expecter_ by Gary Bernhardt
3236
- mock_ by Michael Foord
3337
- coverage_ by Ned Batchelder

docs/index.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,12 +126,6 @@ Contributor Friendly Work
126126

127127
In order of importance:
128128

129-
Unittests
130-
131-
I really should have written these as I wrote the code. I didn't, so they
132-
need to be written now. If you want to write some, I would sincerely
133-
appreciate it.
134-
135129
Documentation
136130

137131
I know I'm not the best at writing documentation so if you want to clarify
@@ -152,6 +146,7 @@ Running the Unittests
152146
virtualenv .
153147
cd /path/to/github3.py_repo/requirements.txt
154148
pip install -r requirements.txt
149+
# Or you could run make test-deps
155150
make tests
156151

157152

0 commit comments

Comments
 (0)