Skip to content

Commit 048ffa5

Browse files
committed
Improved installation docs to mention pip, not easy_install
Fixes #235 [ci skip]
1 parent df95149 commit 048ffa5

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

‎doc/source/intro.rst

+7-12
Original file line numberDiff line numberDiff line change
@@ -17,39 +17,34 @@ Requirements
1717
It should also work with older versions, but it may be that some operations
1818
involving remotes will not work as expected.
1919
* `GitDB`_ - a pure python git database implementation
20-
21-
* `async`_ - asynchronous task scheduling
22-
2320
* `Python Nose`_ - used for running the tests
2421
* `Mock by Michael Foord`_ used for tests. Requires version 0.5
2522

2623
.. _Git: http://git-scm.com/
2724
.. _Python Nose: http://code.google.com/p/python-nose/
2825
.. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock.html
2926
.. _GitDB: http://pypi.python.org/pypi/gitdb
30-
.. _async: http://pypi.python.org/pypi/async
3127

3228
Installing GitPython
3329
====================
3430

3531
Installing GitPython is easily done using
36-
`setuptools`_. Assuming it is
32+
`pip`_. Assuming it is
3733
installed, just run the following from the command-line:
3834

3935
.. sourcecode:: none
4036

41-
# easy_install GitPython
37+
# pip install gitpython
4238

4339
This command will download the latest version of GitPython from the
4440
`Python Package Index <http://pypi.python.org/pypi/GitPython>`_ and install it
45-
to your system. More information about ``easy_install`` and pypi can be found
41+
to your system. More information about ``pip`` and pypi can be found
4642
here:
4743

48-
* `setuptools`_
49-
* `install setuptools <http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions>`_
44+
* `install pip <https://pip.pypa.io/en/latest/installing.html>`_
5045
* `pypi <https://pypi.python.org/pypi/GitPython>`_
5146

52-
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
47+
.. _pip: https://pip.pypa.io/en/latest/installing.html
5348

5449
Alternatively, you can install from the distribution using the ``setup.py``
5550
script:
@@ -58,7 +53,7 @@ script:
5853

5954
# python setup.py install
6055

61-
.. note:: In this case, you have to manually install `GitDB`_ and `async`_ as well. It would be recommended to use the :ref:`git source repository <source-code-label>` in that case.
56+
.. note:: In this case, you have to manually install `GitDB`_ as well. It would be recommended to use the :ref:`git source repository <source-code-label>` in that case.
6257

6358
Getting Started
6459
===============
@@ -84,7 +79,7 @@ GitPython's git repo is available on GitHub, which can be browsed at:
8479

8580
and cloned using::
8681

87-
$ git clone git://github.com/gitpython-developers/GitPython.git git-python
82+
$ git clone https://github.com/gitpython-developers/GitPython git-python
8883
8984
Initialize all submodules to obtain the required dependencies with::
9085

‎git/repo/base.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -869,8 +869,9 @@ def archive(self, ostream, treeish=None, prefix=None, **kwargs):
869869
return self
870870

871871
def has_separate_working_tree(self):
872-
""":return: True if our git_dir is not at the root of our working_tree_dir, but a .git file with a
873-
platform agnositic symbolic link. Our git_dir will be whereever the .git file points to
872+
"""
873+
:return: True if our git_dir is not at the root of our working_tree_dir, but a .git file with a
874+
platform agnositic symbolic link. Our git_dir will be whereever the .git file points to
874875
:note: bare repositories will always return False here
875876
"""
876877
if self.bare:

0 commit comments

Comments
 (0)