Skip to content

Commit 7ba347f

Browse files
committed
docs(hacking+README): clarify that deis CLI requires python 2.7
1 parent c1de074 commit 7ba347f

2 files changed

Lines changed: 14 additions & 14 deletions

File tree

client/README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,19 @@ Get Started
6868

6969
1. `Install the Client`_:
7070

71-
Your Deis client should match your server's version. For development, an
72-
easy way to ensure this is to run `client/deis.py` in the code repository
73-
you used to provision the server. You can make a symlink or shell alias for
74-
`deis` to that file:
71+
Your Deis client should match your server's version. For developers, one way
72+
to ensure this is to use `Python 2.7`_ to install requirements and then run
73+
``client/deis.py`` in the Deis code repository. Then make a symlink or shell
74+
alias for ``deis`` to ensure it is found in your ``$PATH``:
7575

7676
.. code-block:: console
7777
78-
$ pip install docopt==0.6.2 python-dateutil==2.2 PyYAML==3.11 requests==2.4.3 termcolor==1.1.0
78+
$ make -C client/ install
7979
$ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
8080
$ deis
8181
Usage: deis <command> [<args>...]
8282
83-
If you don't have Python_, install the latest `deis` binary executable for
83+
If you don't have Python 2.7, install the latest `deis` binary executable for
8484
Linux or Mac OS X with this command:
8585

8686
.. code-block:: console
@@ -140,7 +140,7 @@ somewhere in your $PATH.
140140
To learn more, use ``deis help`` or browse `the documentation`_.
141141

142142
.. _`Install the Client`: http://docs.deis.io/en/latest/using_deis/install-client/
143-
.. _`Python`: http://www.python.org/
143+
.. _`Python 2.7`: https://www.python.org/downloads/release/python-279/
144144
.. _`Register a User`: http://docs.deis.io/en/latest/using_deis/register-user/
145145
.. _`Deploy an Application`: http://docs.deis.io/en/latest/using_deis/deploy-application/
146146
.. _`Manage an Application`: http://docs.deis.io/en/latest/using_deis/manage-application/

docs/contributing/hacking.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,19 @@ then clone your fork of the repository:
3434
3535
$ git clone git@github.com:<username>/deis.git
3636
$ cd deis
37-
$ export DEIS_DIR=`pwd` # to use in future commands
3837
3938
Install the Client
4039
------------------
4140

42-
In a development environment you'll want to use the latest version of the client. Install
43-
its dependencies by using the Makefile and symlinking ``client/deis.py`` to ``deis`` on
44-
your local workstation.
41+
Your Deis client should match your server's version. For developers, one way
42+
to ensure this is to use `Python 2.7`_ to install requirements and then run
43+
``client/deis.py`` in the Deis code repository. Then make a symlink or shell
44+
alias for ``deis`` to ensure it is found in your ``$PATH``:
4545

4646
.. code-block:: console
4747
48-
$ cd $DEIS_DIR/client
49-
$ make install
50-
$ sudo ln -fs $DEIS_DIR/client/deis.py /usr/local/bin/deis
48+
$ make -C client/ install
49+
$ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
5150
$ deis
5251
Usage: deis <command> [<args>...]
5352
@@ -190,5 +189,6 @@ when proposing a change to Deis.
190189
.. _`easy-fix`: https://github.com/deis/deis/issues?labels=easy-fix&state=open
191190
.. _`deisctl`: https://github.com/deis/deis/tree/master/deisctl
192191
.. _`fork the Deis repository`: https://github.com/deis/deis/fork
192+
.. _`Python 2.7`: https://www.python.org/downloads/release/python-279/
193193
.. _`running the tests`: https://github.com/deis/deis/tree/master/tests#readme
194194
.. _`pull request`: https://github.com/deis/deis/pulls

0 commit comments

Comments
 (0)