-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
54 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,68 @@ | ||
.. installation | ||
============ | ||
Installation | ||
============ | ||
|
||
If you plan on trying out the examples: | ||
Cloning | ||
------- | ||
|
||
We're currently in development mode, so you're better off cloning the repository. Make sure to pull often! | ||
|
||
.. code:: bash | ||
git clone https://github.com/SpectoLabs/hoverpy.git | ||
cd hoverpy | ||
python setup.py test | ||
$ git clone https://github.com/SpectoLabs/hoverpy.git | ||
$ cd hoverpy | ||
# please note, this is not required for running the examples, only for installing your local copy: | ||
# sudo python setup.py install | ||
Or using virtualenv | ||
------------------- | ||
|
||
Or whether you just want to install it using pip (not yet recommended): | ||
If you prefer using virtualenv to keep your environment clean: | ||
|
||
.. code:: bash | ||
pip install --user -i https://testpypi.python.org/pypi hoverpy | ||
$ virtualenv hoverpyenv | ||
$ cd hoverpyenv | ||
$ source bin/activate | ||
$ git clone https://github.com/SpectoLabs/hoverpy.git | ||
$ cd hoverpy | ||
Test | ||
---- | ||
Testing | ||
------- | ||
|
||
Make sure everything is working: | ||
|
||
.. code:: bash | ||
make test | ||
# or | ||
python setup.py test | ||
$ python setup.py test | ||
Running the examples | ||
-------------------- | ||
|
||
.. code:: bash | ||
$ ls examples/* | ||
$ basic delays modify readthedocs tornado unittesting urllib2eg urllib3eg | ||
$ python examples/basic/basic.py | ||
Please note we'll cover the examples in `usage`_ page. | ||
|
||
.. _usage: usage.html | ||
|
||
Installing from repo | ||
-------------------- | ||
|
||
Please note there isn't yet much point installing HoverPy since we're currently still in development mode. This means the code will change often. But if you really want to, then here's the command: | ||
|
||
.. code:: bash | ||
sudo python setup.py install | ||
Installing from PIP | ||
------------------- | ||
|
||
You can also install HoverPy from PIP, however once again you're better off playing with your repo clone for now. But if you really wish so, then here's how you can do so: | ||
|
||
.. code:: bash | ||
pip install --user -i https://testpypi.python.org/pypi hoverpy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
.. _usage | ||
===== | ||
Usage | ||
===== | ||
|
||
|