Use namespaces

.gitignore

@@ -11,3 +11,4 @@ src
 develop-eggs
 built-docs
 dist
+sphinx

buildout.cfg

@@ -13,7 +13,7 @@ versions = versions
 ;current sys.path settings. Also note that your current 'eggs' directory may
 ;not take precedence over that.
 eggs = bob==master
-       bob.db.replay
+       xbob.db.replay
 
 [versions]
 ;If you would like to pin-down the recipes package version so you are not

docs/conf.py

@@ -77,10 +77,10 @@ copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')
 # built documents.
 #
 # The short X.Y version.
-from replay.db import version as db_version
-version = db_version()
+from xbob.db.replay.driver import Interface
+version = Interface().version()
 # The full version, including alpha/beta/rc tags.
-release = db_version()
+release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -6,6 +6,6 @@
  Replay Attack Database
 ========================
 
-.. automodule:: replay.db
+.. automodule:: xbob.db.replay
 
-.. autoclass:: replay.db.Database
+.. autoclass:: xbob.db.replay.Database

setup.py

@@ -9,7 +9,7 @@ from setuptools import setup, find_packages
 # parameters that define our package.
 setup(
 
-    name='bob.db.replay',
+    name='xbob.db.replay',
     version='master',
     description='Replay Attack Database Access API for Bob',
     url='http://github.com/bioidiap/bob.db.replay',
@@ -24,23 +24,24 @@ setup(
     zip_safe=False,
 
     install_requires=[
-        "bob",  # base signal proc./machine learning library
+      'setuptools',
+      'bob',  # base signal proc./machine learning library
     ],
 
-    entry_points={
-      'console_scripts': [
-        # for tests or db creation, enable the following line:
-        #'replay_manager.py = bob.db.script.dbmanage:main',
-        ],
-      
+    namespace_packages = [
+      'xbob',
+      'xbob.db',
+      ],
+
+    entry_points = {
       # bob database declaration
       'bob.db': [
-        'replay = replay.db.driver:Interface',
+        'replay = xbob.db.replay.driver:Interface',
         ],
 
       # bob unittest declaration
       'bob.test': [
-        'replay = replay.test:ReplayDatabaseTest',
+        'replay = xbob.db.replay.test:ReplayDatabaseTest',
         ],
       },
 

xbob/__init__.py

+#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
+__import__('pkg_resources').declare_namespace(__name__)

xbob/db/__init__.py

+#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
+__import__('pkg_resources').declare_namespace(__name__)

replay/db/__init__.py → xbob/db/replay/__init__.py

@@ -25,4 +25,5 @@ on your references:
 """
 
 from .query import Database
-__all__ = dir()
+
+__all__ = ['Database']

replay/db/driver.py → xbob/db/replay/driver.py

@@ -81,7 +81,7 @@ class Interface(BaseInterface):
 
   def version(self):
     import pkg_resources  # part of setuptools
-    return pkg_resources.require('bob.db.%s' % self.name())[0].version
+    return pkg_resources.require('xbob.db.%s' % self.name())[0].version
 
   def location(self):
     return os.path.dirname(os.path.realpath(__file__))