From 1053448ad885c633af9805a750d6187d19efaa6c Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 30 Nov 2010 21:29:08 +0100 Subject: Renamed readme file to something github understands much better, adjusted documentation links to point to github instead of lighthouse/gitorious --- README | 61 ----------------------------------------------- README.rst | 63 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/source/intro.rst | 12 +++++----- doc/source/roadmap.rst | 5 +++- doc/source/tutorial.rst | 4 ++-- 5 files changed, 75 insertions(+), 70 deletions(-) delete mode 100644 README create mode 100644 README.rst diff --git a/README b/README deleted file mode 100644 index e0f2947d..00000000 --- a/README +++ /dev/null @@ -1,61 +0,0 @@ -========== -GitPython -========== - -GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing. - -It provides abstractions of git objects for easy access of repository data, and additionally allows you to access the git repository more directly using either a pure python implementation, or the faster, but more resource intensive git command implementation. - -The object database implementation is optimized for handling large quantities of objects and large datasets, which is achieved by using low-level structures and data streaming. - -REQUIREMENTS -============ - -* Git ( tested with 1.7.3.2 ) -* Python Nose - used for running the tests -* Mock by Michael Foord used for tests. Requires 0.5 - -INSTALL -======= -If you have downloaded the source code: - - python setup.py install - -or if you want to obtain a copy more easily: - - easy_install gitpython - -A distribution package can be obtained for manual installation at: - - http://pypi.python.org/pypi/GitPython - -SOURCE -====== - -GitPython's git repo is available on GitHub, which can be browsed at: - -http://github.com/Byron/GitPython - -and cloned using: - -git clone git://github.com/Byron/GitPython.git git-python - - -DOCUMENTATION -============= -The html-compiled documentation can be found at the following URL: - -http://packages.python.org/GitPython/ - -MAILING LIST -============ -http://groups.google.com/group/git-python - -ISSUE TRACKER -============= -http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones - -LICENSE -======= - -New BSD License. See the LICENSE file. diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..0e50b50b --- /dev/null +++ b/README.rst @@ -0,0 +1,63 @@ +========== +GitPython +========== + +GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing. + +It provides abstractions of git objects for easy access of repository data, and additionally allows you to access the git repository more directly using either a pure python implementation, or the faster, but more resource intensive git command implementation. + +The object database implementation is optimized for handling large quantities of objects and large datasets, which is achieved by using low-level structures and data streaming. + +REQUIREMENTS +============ + +* Git ( tested with 1.7.3.2 ) +* Python Nose - used for running the tests +* Mock by Michael Foord used for tests. Requires 0.5 + +INSTALL +======= +If you have downloaded the source code: + + python setup.py install + +or if you want to obtain a copy more easily: + + easy_install gitpython + +A distribution package can be obtained for manual installation at: + + http://pypi.python.org/pypi/GitPython + +SOURCE +====== + +GitPython's git repo is available on GitHub, which can be browsed at: + +https://github.com/gitpython-developers/GitPython + +and cloned using: + +git clone git://github.com/gitpython-developers/GitPython.git git-python + + +DOCUMENTATION +============= +The html-compiled documentation can be found at the following URL: + +http://packages.python.org/GitPython/ + +MAILING LIST +============ +http://groups.google.com/group/git-python + +ISSUE TRACKER +============= +Issues are tracked on github: + +https://github.com/gitpython-developers/GitPython/issues + +LICENSE +======= + +New BSD License. See the LICENSE file. diff --git a/doc/source/intro.rst b/doc/source/intro.rst index c96766fb..520cf159 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -78,15 +78,13 @@ An organized section of the GitPthon API is at :ref:`api_reference_toplevel`. Source Code =========== -GitPython's git repo is available on Gitorious and GitHub, which can be browsed at: +GitPython's git repo is available on GitHub, which can be browsed at: - * http://gitorious.org/projects/git-python/ - * http://github.com/Byron/GitPython + * https://github.com/gitpython-developers/GitPython and cloned using:: - $ git clone git://gitorious.org/git-python/mainline.git git-python - $ git clone git://github.com/Byron/GitPython.git git-python + $ git clone git://github.com/gitpython-developers/GitPython.git git-python Initialize all submodules to obtain the required dependencies with:: @@ -103,7 +101,9 @@ http://groups.google.com/group/git-python Issue Tracker ============= -http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones +The issue tracker is hosted by github: + +https://github.com/gitpython-developers/GitPython/issues License Information =================== diff --git a/doc/source/roadmap.rst b/doc/source/roadmap.rst index a6bdc3a0..f93d5e65 100644 --- a/doc/source/roadmap.rst +++ b/doc/source/roadmap.rst @@ -2,5 +2,8 @@ ####### Roadmap ####### -The full list of milestones including associated tasks can be found on lighthouse: http://byronimo.lighthouseapp.com/projects/51787-gitpython/milestones +The full list of milestones including associated tasks can be found on github: +https://github.com/gitpython-developers/GitPython/issues + +Select the respective milestone to filter the list of issues accordingly. diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index 642136ab..5530cedd 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -337,7 +337,7 @@ In the following brief example, you will learn about the very basics, assuming y >>> repo = Repo('path/to/git-python/repository') >>> sms = repo.submodules - [git.Submodule(name=gitdb, path=lib/git/ext/gitdb, url=git://gitorious.org/git-python/gitdb.git, branch=master)] + [git.Submodule(name=gitdb, path=lib/git/ext/gitdb, url=git://github.com/gitpython-developers/GitPython.git, branch=master)] >>> sm = sms[0] >>> sm.name 'gitdb' @@ -354,7 +354,7 @@ In the following brief example, you will learn about the very basics, assuming y >>> sm.config_reader().get_value('path') == sm.path # read its configuration conveniently True >>> sm.children() # query the submodule hierarchy - [git.Submodule(name=async, path=ext/async, url=git://gitorious.org/git-python/async.git, branch=master)] + [git.Submodule(name=async, path=ext/async, url=git://github.com/gitpython-developers/async.git, branch=master)] In addition to the query functionality, you can move the submodule's repository to a different path <``move(...)``>, write its configuration <``config_writer().set_value(...)``>, update its working tree <``update(...)``>, and remove and add them <``remove(...)``, ``add(...)``>. -- cgit v1.2.1