diff --git a/README.rst b/README.rst index cab36f07..23caaa8a 100644 --- a/README.rst +++ b/README.rst @@ -12,6 +12,13 @@ a `tutorial `_, a `user guide `_ and an `API reference `_. +Installation +============ +If you have `setuptools `_ +you can use ``easy_install mongoengine``. Otherwise, you can download the +source from `GitHub `_ and run ``python +setup.py install``. + Dependencies ============ - pymongo 1.1+ @@ -69,3 +76,14 @@ Some simple examples of what MongoEngine code looks like:: 2 >>> len(BlogPost.objects(tags='mongodb')) 1 + +Tests +===== +To run the test suite, ensure you are running a local instance of MongoDB on +the standard port, and run ``python setup.py test``. + +Contributing +============ +The source is available on `GitHub `_ - to +contribute to the project, fork it on GitHub and send a pull request, all +contributions and suggestions are welcome! diff --git a/docs/conf.py b/docs/conf.py index 5abb2028..bc6725d2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ import mongoengine # The short X.Y version. version = mongoengine.get_version() # The full version, including alpha/beta/rc tags. -release = mongoengine.get_release() +release = mongoengine.get_version() # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/mongoengine/__init__.py b/mongoengine/__init__.py index 2b308da4..cf20d9ca 100644 --- a/mongoengine/__init__.py +++ b/mongoengine/__init__.py @@ -12,7 +12,7 @@ __all__ = (document.__all__ + fields.__all__ + connection.__all__ + __author__ = 'Harry Marr' -VERSION = (0, 1, 0, 'beta') +VERSION = (0, 1, 1) def get_version(): version = '%s.%s' % (VERSION[0], VERSION[1]) @@ -20,11 +20,5 @@ def get_version(): version = '%s.%s' % (version, VERSION[2]) return version -def get_release(): - version = get_version() - if VERSION[3] != 'final': - version = '%s-%s' % (version, VERSION[3]) - return version - -__version__ = get_release() +__version__ = get_version() diff --git a/setup.py b/setup.py index 3bc2e691..e5f373ed 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,6 @@ from setuptools import setup -VERSION = '0.1' +VERSION = '0.1.1' DESCRIPTION = "A Python Document-Object Mapper for working with MongoDB" @@ -32,4 +32,5 @@ setup(name='mongoengine', platforms=['any'], classifiers=CLASSIFIERS, install_requires=['pymongo'], + test_suite='tests', )