Commits

Artur Barseghyan committed ba0135b Draft

update description and docs

  • Participants
  • Parent commits 9b621ff

Comments (0)

Files changed (4)

 =======================================
 eximagination
 =======================================
-A Django template tag library which allows downloading of external images right from the template and save it
-into a desired context variable along with `width` and `height` of the image fetched. Caches the fetched images
-locally.
+A Django template tag library which allows to download external images, store them locally and return the
+local path to locally stored image to a desired context variable, along with `width` and `height` of the
+image fetched. Caches the fetched images locally for the given time (set in settings).
 
 You could, for example, use this app to solve the problems with displaying of a mixed content (assets loaded
 from HTTP and HTTPS sources).
 
     $ pip install eximagination
 
+Latest stable version from github:
+
+    $ pip install -e git+https://github.com/barseghyanartur/eximagination/@stable#egg=eximagination
+
 Latest stable version from bitbucket:
 
     $ pip install -e hg+http://bitbucket.org/barseghyanartur/eximagination@stable#egg=eximagination
 
-Latest stable version from github:
-
-    $ pip install -e git+https://github.com/barseghyanartur/eximagination/@stable#egg=eximagination
-
 2. Add 'eximagination' to `INSTALLED_APPS`
 
 >>> INSTALLED_APPS = (
 =======================================
 eximagination
 =======================================
+A Django template tag library which allows to download external images, store them locally and return the
+local path to locally stored image to a desired context variable, along with `width` and `height` of the
+image fetched. Caches the fetched images locally for the given time (set in settings).
 
-Description
+You could, for example, use this app to solve the problems with displaying of a mixed content (assets loaded
+from HTTP and HTTPS sources).
+
+Prerequisites
 =======================================
-A Django template tag library which allows downloading of external images right from the template and save it into a
-desired context variable along with `width` and `height` of the image fetched. Caches the fetched images locally.
-You could, for example, use this app to solve the problems with displaying of a mixed content (assets loaded from HTTP and HTTPS
-sources).
+- Django 1.5.+
+- Python 2.6.8+, 2.7.+, 3.3.+
 
 Installation
 =======================================
 
     $ pip install eximagination
 
-Latest development version from source:
+Latest stable version from github:
 
-    $ pip install -e hg+http://bitbucket.org/barseghyanartur/eximagination@dev#egg=eximagination
+    $ pip install -e git+https://github.com/barseghyanartur/eximagination/@stable#egg=eximagination
+
+Latest stable version from bitbucket:
+
+    $ pip install -e hg+http://bitbucket.org/barseghyanartur/eximagination@stable#egg=eximagination
 
 2. Add 'eximagination' to `INSTALLED_APPS`
 
 
 In both cases there are two additional context variables added:
 
-    `ei_width` - Width of the image
+    ``ei_width`` - Width of the image
 
-    `ei_height` - Height of the image
+    ``ei_height`` - Height of the image
 
 License
 =======================================
 =======================================
 Artur Barseghyan <artur.barseghyan@gmail.com>
 
+Documentation
+=======================================
+
 :mod:`eximaginate` Module
--------------------------
+---------------------------------------
 
 .. automodule:: eximagination.templatetags.eximaginate
     :members:
     :show-inheritance:
 
 :mod:`conf` Module
-------------------
+---------------------------------------
 
 .. automodule:: eximagination.conf
     :members:
     :show-inheritance:
 
 Indices and tables
-==================
+=======================================
 
 * :ref:`genindex`
 * :ref:`modindex`

example/requirements.txt

 six==1.4.1
 tox==1.6.1
 
-#-e hg+http://bitbucket.org/barseghyanartur/eximagination@stable#egg=eximagination
+-e hg+http://bitbucket.org/barseghyanartur/eximagination@stable#egg=eximagination
 from setuptools import setup, find_packages
 
 try:
-    readme = open(os.path.join(os.path.dirname(__file__), 'readme.rst')).read()
+    readme = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()
 except:
     readme = ''
 
 setup(
     name = 'eximagination',
     version = version,
-    description = ("Eximagination package for copying external images in tempalate tags and storing them locally."),
+    description = (
+        "A Django template tag library which allows to download external images, store them locally "
+        "and return the local path to locally stored image to a desired context variable"
+        ),
     long_description = readme,
     classifiers = [
         "Framework :: Django",
     keywords = 'eximagination, django, external images, app, python',
     author = 'Artur Barseghyan',
     author_email = 'artur.barseghyan@gmail.com',
-    url = 'https://bitbucket.org/barseghyanartur/eximagination',
+    url = 'https://github.com/barseghyanartur/eximagination',
     package_dir = {'':'src'},
     packages = find_packages(where='./src'),
     license = 'GPL 2.0/LGPL 2.1',