Skip to content

Commit 8a777fd

Browse files
SLsthompsonSLsthompson
committed
Updated documentation to reflect changes to the github setup and installation procedures
1 parent 639bc49 commit 8a777fd

2 files changed

Lines changed: 27 additions & 16 deletions

File tree

‎docs/dev/index.rst‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,33 @@ Code Organization
2020

2121
Setting Up A Dev Environment
2222
----------------------------
23-
Before installing/downloading anything I highly recommend learning how to use Python's `virtualenv <https://pypi.python.org/pypi/virtualenv>`_. Virtualenv allows you to have isolated python environments, which is extremely useful for development. After you have a virtualenv, download the SoftLayer API Python Bindings source code. That's explained here: :ref:`install`. After you have the source, change into the base directory and run the following to install the pre-requisites for testing the project. Make sure you've activated your virtualenv before you do this.
23+
Before working with the SoftLayer Python API client source, we strongly recommend that you know how to use Python's virtualization environment, `virtualenv <https://pypi.python.org/pypi/virtualenv>`_. Virtualenv allows you to create Python setups that are individually tailored to particular develpment efforts. Each environment can have its own set of libraries, and even its own Python interpreter; each is isolated from the other environments so the possibilities difficulties arising from library conflicts is reduced.
24+
25+
After you have virtualenv, you should set up a virtual environment and activate it whenever you are working on softlayer-python. The commands needed to setup an environment and activate it might look something like this:
2426

2527
::
2628

27-
pip install -r requirements
29+
virtualenv --no-site-packages softlayer_env
30+
31+
source softlayer_env/bin/activate
32+
33+
Please refer to the virtualenv documentation for more information about creating, and working with virtual environments.
34+
35+
Once you have an appropriate environment, you will then download the SoftLayer API Python Bindings source code by following the :ref:`installation instructions <install_from_source>`. Change into softlayer-python source directory and run the following to install the pre-requisites needed to run the development tests:
36+
37+
::
38+
39+
pip install -r tools/test-requirements.txt
2840

2941

3042
Testing
3143
-------
32-
The project have a mix of functional and unit tests. All the tests run using `nose <https://nose.readthedocs.org>`_. To run the test suite, change into the base directory and run:
44+
The project have a mix of functional and unit tests. All the tests run using `nose <https://nose.readthedocs.org>`_. Some of the tests make use of the `mock <http://www.voidspace.org.uk/python/mock/>`_ package. To run the test suite, change into the base directory and run:
3345

3446
::
3547

3648
python setup.py nosetests
3749

38-
3950
To test with all supported versions of Python, this project utilizes `tox <https://pypi.python.org/pypi/tox>`_.
4051

4152
To avoid having to install those versions of Python locally, you can also set up `Travis <https://travis-ci.org>`_ on your fork. This can run all the required tests on every code push to github. This is highly recommended.
@@ -61,7 +72,7 @@ The primary docs are built at `Read the Docs <https://readthedocs.org/projects/s
6172

6273
Style
6374
-----
64-
This project follows :pep:`8` and most of the style suggestions that pyflakes recommends. `Flake8 <https://pypi.python.org/pypi/flake8/2.0>`_ should be ran regularly.
75+
This project follows :pep:`8` and most of the style suggestions that pyflakes recommends. Run `Flake8 <https://pypi.python.org/pypi/flake8/2.0>`_ regularly.
6576

6677

6778
Contributing

‎docs/install.rst‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,34 @@ Install via pip: ::
1010

1111
$ pip install softlayer
1212

13-
Install from source gia pip (requires git): ::
13+
Install from source via pip (requires `git <http://git-scm.com>`_): ::
1414

15-
$ pip install git+git://github.com/softlayer/softlayer-api-python-client.git
15+
$ pip install git+git://github.com/softlayer/softlayer-python.git
1616

17-
The most up to date version of this library can be found on the SoftLayer GitHub public repositories: https://github.com/softlayer. Please post to the SoftLayer forums https://forums.softlayer.com/ or open a support ticket in the SoftLayer customer portal if you have any questions regarding use of this library.
17+
The most up to date version of this library can be found on the `SoftLayer GitHub public repositories <https://github.com/softlayer>`_. Please post to the `SoftLayer Forums <https://forums.softlayer.com/>`_ or open a support ticket in the `SoftLayer Customer Portal <https://control.softlayer.com>`_ if you have any questions regarding use of this library.
1818

1919
.. _install_from_source:
2020

2121
From Source
2222
-----------
2323

24-
The project is developed on GitHub, at `github.com/softlayer/softlayer-api-python-client <https://github.com/softlayer/softlayer-api-python-client>`_.
25-
24+
The project is developed on GitHub, at `https://github.com/softlayer/softlayer-python <https://github.com/softlayer/softlayer-python>`_.
2625

2726
You can clone the public repository::
2827

29-
$ git clone git://github.com/softlayer/softlayer-api-python-client.git
30-
31-
Or, Download the `tarball <https://github.com/softlayer/softlayer-api-python-client/tarball/master>`_::
28+
$ git clone [email protected]:softlayer/softlayer-python.git
3229

33-
$ curl -OL https://github.com/softlayer/softlayer-api-python-client/tarball/master
30+
Or, Download the `tarball <https://github.com/softlayer/softlayer-python/tarball/master>`_::
3431

35-
Or, download the `zipball <https://github.com/softlayer/softlayer-api-python-client/zipball/master>`_::
32+
$ curl -OL https://github.com/softlayer/softlayer-python/tarball/master
3633

37-
$ curl -OL https://github.com/softlayer/softlayer-api-python-client/zipball/master
34+
Or, download the `zipball <https://github.com/softlayer/softlayer-python/zipball/master>`_::
3835

36+
$ curl -OL https://github.com/softlayer/softlayer-python/zipball/master
3937

4038
Once you have a copy of the source, you can embed it in your Python package,
4139
or install it into your site-packages easily::
4240

4341
$ python setup.py install
42+
43+
For more information about working with they source, or contributing to the project, please see the :ref:`Contribution Guide <api_dev>`.

0 commit comments

Comments
 (0)