If you're familiar with django apps, this process will be fairly natural.
-I'm not planning on pushing this project to PyPI until the code has been
-**tested** thoroughly **in production**, so for now installation should be handled
+Install using your choice of ``pip`` or ``easy_install``: ::
+ $ pip install django-trawler
+ $ easy_install django-trawler
-This section expects you to have a basic familiarity with `pip <http://www.pip-installer.org/>`_,
-`virtualenv <http://www.virtualenv.org/>`_, and optionally
-`virtualenvwrapper <http://www.doughellmann.com/projects/virtualenvwrapper/>`_ (recommended).
-.. Hiding the below block until the project has been sent to PyPI.
- Once this package has been pushed out to PyPI, simply naming the package will
``easy_install django-trawler`` or ``pip install django-trawler``
-Using ``pip``, you can install directly from the repo.
-``pip install hg+https://bitbucket.org/onelson/django-trawler#egg=django-trawler``
-If you're like me (hacking on the package itself), my recommendation is to setup
-a virtualenv, clone the project repo, then run ``python setup.py develop``.
-Theres a small test project/site that can be used to run the code included with
-the project, so you'll be all set.
-Here's an example using pip+virtualenv+virtualenvwrapper: ::
- owen@enso:~/workspace$ mkvirtualenv foo
- (foo)owen@enso:~/workspace$ hg clone https://bitbucket.org/onelson/django-trawler my_trawler
- (foo)owen@enso:~/workspace$ cd my_trawler/
- (foo)owen@enso:~/workspace/my_trawler$ ls
- docs pylintrc setup.py test_proj trawler
- (foo)owen@enso:~/workspace/my_trawler$ python setup.py develop
- Finished processing dependencies for django-trawler==0.1a
-It's worth noting that while working with the selected virtualenv, ``python`` is
-the executable based in the virtualenv, so when you run ``python setup.py develop``
-it's creating a link in your virtualenv's site-packages (not your global system's).
-Once this link is created, you can run ``python manage.py [...]`` in the ``test_proj``
-directory and that project should be able to *find* the trawler code in the ``sys.path``.
-Django itself is listed as a dependency in trawler's setup.py, so regardless of
-the installation source or method, you should have everything you need in place
-to fire up the app. All that is required of you is the customization of a few
-key settings in the ``test_proj/settings.py`` (or your own, if you're deploying
-**for reals**). Here are the highlights...
-* Add ``trawler`` to ``INSTALLED_APPS``.
-* Ensure your mail settings are appropriate (the app needs to send mail,
- or not if in development).
-* Enable the admin site to use the trawler interface.
+* Add ``trawler`` and ``django.contrib.admin`` to ``INSTALLED_APPS``.
+* Ensure your mail settings are appropriate (the app needs to send mail).
* Ensure you set the domain for your server (django ``Sites`` framework) so
admin links point to the right place.
* Include ``trawler.urls`` in your urlconf.