diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 00000000..a5021c60 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include README.rst +include LICENSE diff --git a/docs/index.rst b/docs/index.rst index 187f98f5..6db8cf38 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,14 +1,14 @@ -.. MongoEngine documentation master file, created by - sphinx-quickstart on Sun Nov 22 18:14:13 2009. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - MongoEngine User Documentation ======================================= MongoEngine is an Object-Document Mapper, written in Python for working with -MongoDB. The source is available on -`GitHub `_. +MongoDB. To install it, simply run + +.. code-block:: console + + # easy_install mongoengine + +The source is available on `GitHub `_. .. toctree:: :maxdepth: 2 diff --git a/docs/userguide.rst b/docs/userguide.rst index 296816e0..294a0de0 100644 --- a/docs/userguide.rst +++ b/docs/userguide.rst @@ -4,6 +4,22 @@ User Guide .. _guide-connecting: +Installing +========== +MongoEngine is available on PyPI, so to use it you can use +:program:`easy_install` + +.. code-block:: console + + # easy_install mongoengine + +Alternatively, if you don't have setuptools installed, `download it from PyPi +`_ and run + +.. code-block:: console + + # python setup.py install + Connecting to MongoDB ===================== To connect to a running instance of :program:`mongod`, use the diff --git a/setup.py b/setup.py new file mode 100644 index 00000000..3bc2e691 --- /dev/null +++ b/setup.py @@ -0,0 +1,35 @@ +from setuptools import setup + +VERSION = '0.1' + +DESCRIPTION = "A Python Document-Object Mapper for working with MongoDB" + +LONG_DESCRIPTION = None +try: + LONG_DESCRIPTION = open('README.rst').read() +except: + pass + +CLASSIFIERS = [ + 'Development Status :: 4 - Beta', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: MIT License', + 'Operating System :: OS Independent', + 'Programming Language :: Python', + 'Topic :: Database', + 'Topic :: Software Development :: Libraries :: Python Modules', +] + +setup(name='mongoengine', + version=VERSION, + packages=['mongoengine'], + author='Harry Marr', + author_email='harry.marr@{nospam}gmail.com', + url='http://hmarr.com/mongoengine/', + license='MIT', + description=DESCRIPTION, + long_description=LONG_DESCRIPTION, + platforms=['any'], + classifiers=CLASSIFIERS, + install_requires=['pymongo'], +)