Added requirements.txt for pip, and optimized test-suite performance on travis.

With a bit of luck, this one will just work now.

Author: Byron

.travis.yml

@@ -7,7 +7,6 @@ python:
   # - "pypy" - won't work as smmap doesn't work (see smmap/.travis.yml for details)
 
 install:
-  - git submodule update --init --recursive
   - pip install coveralls
 script: 
   - nosetests

README.rst

@@ -1,10 +1,7 @@
 GitDB
 =====
 
-GitDB allows you to access bare git repositories for reading and writing. It 
-aims at allowing full access to loose objects as well as packs with performance 
-and scalability in mind. It operates exclusively on streams, allowing to operate 
-on large objects with a small memory footprint.
+GitDB allows you to access bare git repositories for reading and writing. It aims at allowing full access to loose objects as well as packs with performance and scalability in mind. It operates exclusively on streams, allowing to handle large objects with a small memory footprint.
 
 Installation
 ============
@@ -23,13 +20,13 @@ From `PyPI <https://pypi.python.org/pypi/gitdb>`_
 REQUIREMENTS
 ============
 
-* Python Nose - for running the tests
+* Python  Nose - for running the tests
 
 SOURCE
 ======
 The source is available in a git repository at gitorious and github:
 
-git://github.com/gitpython-developers/gitdb.git
+https://github.com/gitpython-developers/gitdb
 
 Once the clone is complete, please be sure to initialize the submodules using
 
@@ -40,17 +37,25 @@ Run the tests with
 
  nosetests
 
-MAILING LIST
-============
-http://groups.google.com/group/git-python
-
-ISSUE TRACKER
-=============
+DEVELOPMENT
+===========
 
 .. image:: https://travis-ci.org/gitpython-developers/gitdb.svg?branch=master
     :target: https://travis-ci.org/gitpython-developers/gitdb
-    
-https://github.com/gitpython-developers/gitdb/issues
+
+.. image:: https://coveralls.io/repos/gitpython-developers/gitdb/badge.png
+	:target: https://coveralls.io/r/gitpython-developers/gitdb
+
+The library is considered mature, and not under active development. It's primary (known) use is in git-python.
+
+INFRASTRUCTURE
+==============
+
+* Mailing List
+	* http://groups.google.com/group/git-python
+
+* Issue Tracker
+	* https://github.com/gitpython-developers/gitdb/issues
 
 LICENSE
 =======

doc/source/intro.rst

@@ -11,9 +11,9 @@ Interfaces are used to describe the API, making it easy to provide alternate imp
 ================
 Installing GitDB
 ================
-Its easiest to install gitdb using the *easy_install*  program, which is part of the `setuptools`_::
+Its easiest to install gitdb using the *pip*  program::
     
-    $ easy_install gitdb
+    $ pip install gitdb
     
 As the command will install gitdb in your respective python distribution, you will most likely need root permissions to authorize the required changes.
 
@@ -31,10 +31,8 @@ Source Repository
 =================
 The latest source can be cloned using git from github:
 
- * git://github.com/gitpython-developers/gitdb.git
+ * https://github.com/gitpython-developers/gitdb
 
 License Information
 ===================
 *GitDB* is licensed under the New BSD License.
-
-.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools

gitdb/test/db/test_git.py

@@ -24,9 +24,11 @@ def test_reading(self):
         gitdb_sha = hex_to_bin("5690fd0d3304f378754b23b098bd7cb5f4aa1976")
         assert isinstance(gdb.info(gitdb_sha), OInfo)
         assert isinstance(gdb.stream(gitdb_sha), OStream)
-        assert gdb.size() > 200
+        ni = 50
+        assert gdb.size() >= ni
         sha_list = list(gdb.sha_iter())
         assert len(sha_list) == gdb.size()
+        sha_list = sha_list[:ni] # speed up tests ... 
 
 
         # This is actually a test for compound functionality, but it doesn't

gitdb/test/lib.py

@@ -18,6 +18,7 @@
 import shutil
 import os
 import gc
+from functools import wraps
 
 
 #{ Bases
@@ -30,6 +31,21 @@ class TestBase(unittest.TestCase):
 
 #{ Decorators
 
+def skip_on_travis_ci(func):
+    """All tests decorated with this one will raise SkipTest when run on travis ci.
+    Use it to workaround difficult to solve issues
+    NOTE: copied from bcore (https://github.com/Byron/bcore)"""
+    @wraps(func)
+    def wrapper(self, *args, **kwargs):
+        if 'TRAVIS' in os.environ:
+            import nose
+            raise nose.SkipTest("Cannot run on travis-ci")
+        # end check for travis ci
+        return func(self, *args, **kwargs)
+    # end wrapper
+    return wrapper
+
+
 def with_rw_directory(func):
     """Create a temporary directory which can be written to, remove it if the
     test suceeds, but leave it otherwise to aid additional debugging"""

gitdb/test/performance/__init__.py

@@ -0,0 +1 @@
+

gitdb/test/performance/test_pack.py

@@ -12,13 +12,15 @@
 from gitdb.exc import UnsupportedOperation
 from gitdb.db.pack import PackedDB
 from gitdb.utils.compat import xrange
+from gitdb.test.lib import skip_on_travis_ci
 
 import sys
 import os
 from time import time
 
 class TestPackedDBPerformance(TestBigRepoR):
-    
+
+    @skip_on_travis_ci    
     def test_pack_random_access(self):
         pdb = PackedDB(os.path.join(self.gitrepopath, "objects/pack"))
 
@@ -67,6 +69,7 @@ def test_pack_random_access(self):
         total_kib = total_size / 1000
         print("PDB: Obtained %i streams by sha and read all bytes totallying %i KiB ( %f KiB / s ) in %f s ( %f streams/s )" % (max_items, total_kib, total_kib/elapsed , elapsed, max_items / elapsed), file=sys.stderr)
 
+    @skip_on_travis_ci
     def test_correctness(self):
         pdb = PackedDB(os.path.join(self.gitrepopath, "objects/pack"))
         # disabled for now as it used to work perfectly, checking big repositories takes a long time

gitdb/test/performance/test_pack_streaming.py

@@ -12,6 +12,7 @@
 from gitdb.db.pack import PackedDB
 from gitdb.stream import NullStream
 from gitdb.pack import PackEntity
+from gitdb.test.lib import skip_on_travis_ci
 
 import os
 import sys
@@ -31,6 +32,7 @@ def write(self, d):
 
 class TestPackStreamingPerformance(TestBigRepoR):
 
+    @skip_on_travis_ci
     def test_pack_writing(self):
         # see how fast we can write a pack from object streams.
         # This will not be fast, as we take time for decompressing the streams as well
@@ -56,6 +58,7 @@ def test_pack_writing(self):
         print(sys.stderr, "PDB Streaming: Wrote pack of size %i kb in %f s (%f kb/s)" % (total_kb, elapsed, total_kb/elapsed), sys.stderr)
 
 
+    @skip_on_travis_ci
     def test_stream_reading(self):
         # raise SkipTest()
         pdb = PackedDB(os.path.join(self.gitrepopath, "objects/pack"))

gitdb/test/performance/test_stream.py

@@ -19,7 +19,8 @@
 
 from gitdb.test.lib import (
     make_memory_file,
-    with_rw_directory
+    with_rw_directory,
+    skip_on_travis_ci
 )
 
 
@@ -42,7 +43,8 @@ class TestObjDBPerformance(TestBigRepoR):
 
     large_data_size_bytes = 1000*1000*50        # some MiB should do it
     moderate_data_size_bytes = 1000*1000*1      # just 1 MiB
-    
+ 
+    @skip_on_travis_ci   
     @with_rw_directory
     def test_large_data_streaming(self, path):
         ldb = LooseObjectDB(path)

requirements.txt

@@ -0,0 +1,2 @@
+gitdb
+smmap>=0.8.3

setup.py

@@ -89,7 +89,7 @@ def get_data_files(self):
       license = "BSD License",
       zip_safe=False,
       requires=('smmap (>=0.8.3)', ),
-      install_requires=('smmap >= 0.8.0'),
+      install_requires=('smmap >= 0.8.3'),
       long_description = """GitDB is a pure-Python git object database""",
       # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
       classifiers=[