Added setup.py and MANIFEST.in, added to PyPI

This commit is contained in:
Harry Marr
2010-01-03 02:30:34 +00:00
parent b89982fd99
commit f98e9bd732
4 changed files with 60 additions and 7 deletions

View File

@@ -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 <http://github.com/hmarr/mongoengine>`_.
MongoDB. To install it, simply run
.. code-block:: console
# easy_install mongoengine
The source is available on `GitHub <http://github.com/hmarr/mongoengine>`_.
.. toctree::
:maxdepth: 2

View File

@@ -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
<http://pypi.python.org/pypi/mongoengine/>`_ and run
.. code-block:: console
# python setup.py install
Connecting to MongoDB
=====================
To connect to a running instance of :program:`mongod`, use the