Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

retouched docs and setup.py

git-svn-id: https://django-reusableapps.googlecode.com/svn/trunk@4 7cfdb1fb-383f-0410-8e90-0daa5c5b9012
  • Loading branch information...
commit 0fa0bc8d9b341741833a0411cbe9e52dd5ca77bc 1 parent 948b5d1
leidel authored
View
2  INSTALL.txt
@@ -2,7 +2,7 @@ To install django-reusableapps, run the following command inside this directory:
python setup.py install
-Please note that the bootstrap file of the setuptools ``'ez_setup.py'`` is
+Please note that the bootstrap file of the setuptools 'ez_setup.py' is
bundled with django-reusableapps. During the installation of reusableapps,
the setuptools will be installed. Access to the internet might be needed for
this automatic process. More information on setuptools:
View
9 README.txt → README.rst
@@ -1,12 +1,9 @@
-================================
-Django support for reusable apps
-================================
+====================================
+Reusable Django apps with setuptools
+====================================
This is a python module to enable Django to load reusable, pluggable and
egg-based applications -- think of ``plugins`` or ``components``.
It requires a recent Django SVN checkout and current setuptools.
For detailed installation instructions please have a look at INSTALL.txt.
-
-Best,
-Jannis
View
34 docs/overview.txt
@@ -1,6 +1,6 @@
-=================================
-Django support for reusable apps.
-=================================
+====================================
+Reusable Django apps with setuptools
+====================================
This is yet another approach on enabling Django to load reusable, pluggable,
egg-based applications without changing the Django sourcecode. Think of
@@ -23,11 +23,11 @@ Get the source from the application site at::
http://code.google.com/p/django-reusableapps/
-To install ``reusableapps``, follow these steps:
+To install *reusableapps*, follow these steps:
- 1. Follow the instructions in the `INSTALL.txt file`_.
- 2. Add ``import reusableapps`` to the top of your `setting file`_.
- 3. Add a new setting to your `setting file`_, a list of locations of
+ 1. Follow the instructions in the `INSTALL file`_.
+ 2. Add ``import reusableapps`` to the top of your `settings file`_.
+ 3. Add a new setting to your `settings file`_, a list of locations of
reusable apps, in search order. Note that these paths should use
Unix-style forward slashes, even on Windows.
@@ -47,8 +47,8 @@ To install ``reusableapps``, follow these steps:
Putting it together
-------------------
-When finished with above installation instructions, your `setting file`_
-should look something like this at the bottom::
+Once you finished with above installation instructions, your `settings file`_
+should look something like this::
REUSABLE_APPS_DIRS = (
'/home/jannis/django/reusable_apps',
@@ -76,10 +76,10 @@ If you want to use templates from a egg-based Django app please add
``'django.template.loaders.eggs.load_template_source'`` to the ``TEMPLATE_LOADERS_``
setting.
-.. _INSTALL.txt file: http://django-reusableapps.googlecode.com/svn/trunk/INSTALL.txt
-.. _setting file: http://www.djangoproject.com/documentation/settings/
-.. _INSTALLED_APPS: http://www.djangoproject.com/documentation/settings/#installed-apps
-.. _TEMPLATE_LOADERS: http://www.djangoproject.com/documentation/settings/#template-loaders
+.. _INSTALL file: http://django-reusableapps.googlecode.com/svn/trunk/INSTALL.rst
+.. _settings file: http://docs.djangoproject.com/en/dev/ref/settings/
+.. _INSTALLED_APPS: http://docs.djangoproject.com/en/dev/ref/settings/#installed-apps
+.. _TEMPLATE_LOADERS: http://docs.djangoproject.com/en/dev/ref/settings/#template-loaders
Adding support for reusable applications to your own Django app
===============================================================
@@ -95,10 +95,10 @@ Furthermore you need to add an 'entry point' to the setup keywords::
entry_points={'django.apps': 'myapp = myapp'},
where my ``myapp`` is the name of your Django app, e.g. ``registration``.
-A full example can be found at `docs/setup-example.txt`_ and should be copied to
+A full example can be found at setup-example.py_ and should be copied to
the parent directory of your app as ``setup.py``.
-.. _docs/setup-example.txt: http://django-reusableapps.googlecode.com/svn/trunk/docs/setup-example.py.txt
+.. _setup-example.py: http://django-reusableapps.googlecode.com/svn/trunk/docs/setup-example.py
Building egg-based Django apps
==============================
@@ -110,7 +110,7 @@ you can run::
to build a egg file of it. It will be created in the ``dist`` directory and
have a filename like ``dummyapp-0.1-py2.5.egg``. You can then distribute it
-and use it by placing it one of the ``REUSABLE_APPS_DIRS`` of your Django
+and use it by placing it in one of the ``REUSABLE_APPS_DIRS`` of your Django
project.
Support
@@ -119,4 +119,4 @@ Support
Please leave your `questions and problems`_ on the `designated Google Code site`_.
.. _designated Google Code site: http://code.google.com/p/django-reusableapps/
-.. _questions and problems: http://code.google.com/p/django-reusableapps/issues/
+.. _questions and problems: http://code.google.com/p/django-reusableapps/issues/
View
0  docs/setup-example.py.txt → docs/setup-example.py
File renamed without changes
View
2  reusableapps/__init__.py
@@ -1,5 +1,3 @@
-VERSION = "0.1"
-
try:
from pkg_resources import working_set, DistributionNotFound, Environment, \
VersionConflict, UnknownExtra
View
30 setup.py
@@ -4,38 +4,16 @@
from setuptools import setup
app_name = 'reusableapps'
-version = __import__(app_name).VERSION
+version = '0.1.1'
-# Compile the list of packages available, because distutils doesn't have
-# an easy way to do this.
-packages, data_files = [], []
-root_dir = os.path.dirname(__file__)
-if root_dir:
- os.chdir(root_dir)
-
-for dirpath, dirnames, filenames in os.walk(app_name):
- # Ignore dirnames that start with '.'
- for i, dirname in enumerate(dirnames):
- if dirname.startswith('.'): del dirnames[i]
- if '__init__.py' in filenames:
- pkg = dirpath.replace(os.path.sep, '.')
- if os.path.altsep:
- pkg = pkg.replace(os.path.altsep, '.')
- packages.append(pkg)
- elif filenames:
- prefix = dirpath[len(app_name)+1:] # Strip "app_name/" or "app_name\"
- for f in filenames:
- data_files.append(os.path.join(prefix, f))
-
-setup(name=app_name,
+setup(name='django-'+app_name,
version=version,
description='Reusable, pluggable Django apps',
+ long_description=open('README.rst').read(),
author='Jannis Leidel',
author_email='jannis@leidel.info',
url='http://code.google.com/p/django-%s/' % app_name,
- packages=packages,
- package_dir={app_name: app_name},
- package_data={app_name: data_files},
+ packages=['reusableapps'],
classifiers=['Development Status :: 4 - Beta',
'Environment :: Web Environment',
'Intended Audience :: Developers',
Please sign in to comment.
Something went wrong with that request. Please try again.