Documentation updated.

Author: quantra

README.rst

@@ -14,9 +14,9 @@
 Django Lazy srcset
 ==================
 
-Lazy srcset and image generation for Django. Minimum effort required. No database required.
+Lazy srcset and responsive image generation for Django. Minimum effort required. No database required.
 
-Django Lazy srcset will create all the markup and images you need to provide responsive images via the srcset attribute.  All you need to do is install it, configure your breakpoints and use the ``{% srcset %}`` template tag.
+Django Lazy srcset will create the markup and generate the images you need to provide responsive images via the `srcset and sizes attributes for the img tag <https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images#resolution_switching_different_sizes>`_.  All you need to do is install it, configure your breakpoints and use the ``{% srcset %}`` template tag.
 
 All of the hard work (image generation and cacheing) is done by django-imagekit, by default this means images are generated just in time - lazily. Please see the `django-imagekit docs <https://django-imagekit.readthedocs.io>`_ for more info and configuration options.
 
@@ -44,7 +44,7 @@ Add ``"imagekit"`` and ``"lazy_srcset"`` to ``INSTALLED_APPS``:
         # ...
     ]
 
-Configure your breakpoints and stuff:
+Configure your breakpoints and stuff (most/all of this is optional):
 
 .. code-block:: python
 
@@ -93,14 +93,32 @@ Use the ``{% srcset %}`` template tag:
 
 Whilst not required it is advisable to take a nap at this stage.
 
-For further documentation and examples of all the options please read the docstrings in the source code for  `lazy_srcset/templatetags/lazy_srcset.py <https://github.com/Quantra/django-lazy-srcset/blob/master/lazy_srcset/templatetags/lazy_srcset.py>`_.
+For further documentation and examples of all the options please see the huge and obvious docstring in the source code for `lazy_srcset/templatetags/lazy_srcset.py <https://github.com/Quantra/django-lazy-srcset/blob/master/lazy_srcset/templatetags/lazy_srcset.py>`_.
 
-Due to the awesomeness of imagekit it's possible to configure django-lazy-srcset to use any image generator you have registered on a per config basis. Take a look at `lazy_srcset/conf.py <https://github.com/Quantra/django-lazy-srcset/blob/master/lazy_srcset/conf.py>`_ to see how to change the ``generator_id`` setting. For an example image generator look at `lazy_srcset/imagegenerators.py <https://github.com/Quantra/django-lazy-srcset/blob/master/lazy_srcset/imagegenerators.py>`_. This is completely optional but I thought I'd mention it as there are potential artistic uses here; for example you could use a generator to add filters to images.
+Advanced
+--------
+
+Due to the awesomeness of django-imagekit it's possible to configure django-lazy-srcset to use any image generator you have registered on a per config basis. Take a look at `lazy_srcset/conf.py <https://github.com/Quantra/django-lazy-srcset/blob/master/lazy_srcset/conf.py>`_ to see how to change the ``generator_id`` setting. For an example image generator look at `lazy_srcset/imagegenerators.py <https://github.com/Quantra/django-lazy-srcset/blob/master/lazy_srcset/imagegenerators.py>`_. This is completely optional but I thought I'd mention it as there are potential artistic uses here; for example you could use a generator to add filters to some images.
 
 Currently imagekit ``SourceGroup`` has not been implemented therefore the imagekit ``generateimages`` management command will not generate images for django-lazy-srcset. If you want to pre-generate images you can ``render_to_string()`` your templates in an appropriate save method or signal.  If you are using `django-content-blocks <https://github.com/Quantra/django-content-blocks>`_ this happens on publish anyway.
 
 Clean up of old, unused files created by django-lazy-srcset is down to you, if you require it at all.
 
+Development Status & Roadmap
+----------------------------
+
+Django lazy srcset is in beta. There are currently no plans for further development.
+
+Dependencies & Thank You
+------------------------
+
+* https://github.com/matthewwithanm/django-imagekit/
+
+Other Packages to Consider
+--------------------------
+
+* https://github.com/codingjoe/django-pictures
+
 .. shields.io badges
 
 .. |package version| image:: https://img.shields.io/pypi/v/django-lazy-srcset

lazy_srcset/templatetags/lazy_srcset.py

@@ -89,7 +89,7 @@ def sanitize_size(size):
 
     try:
         size, units = int(size[:-2]), size[-2:]
-    except IndexError:
+    except (IndexError, ValueError):
         raise TemplateSyntaxError(
             "Invalid size: %s\nBreakpoints must be integers.\nSizes must specify vw or px units or be integers."
             % size
@@ -137,7 +137,7 @@ def srcset(*args, **kwargs):
     integers which are used to calculate generated image sizes.  They must have units of vw or px only. If no units
     are supplied then vw is assumed.
 
-    kwargs can be used to provide break points and the relative width for each break point directly (ignoring the
+    kwargs can be used to provide break points and the relative size for each break point directly (ignoring the
     config break points and args if you set them for some reason).
 
     The config with the key ``default`` is used unless you provide the config kwarg to specify another config to use.
@@ -183,8 +183,9 @@ def srcset(*args, **kwargs):
     <!-- You can set the default size with units in the same way as the sizes args -->
     <img {% srcset image default_size='300px' %} />
 
-    <!-- You can mix and match all of the above -->
+    <!-- You can mix and match all of the above E.g. -->
     <img {% srcset image 25 33 50 config='custom_breakpoints' max_width=1920 image_quality=50 threshold=100 %} />
+    <img {% srcset image 1920=25 1024=50 default_size=50 image_quality=50 %} />
     """
     # INIT
     args = list(args)
@@ -269,7 +270,7 @@ def srcset(*args, **kwargs):
 
     # GO!
 
-    # Loop through the sizes_dict to create the widths list used for image generation.
+    # Loop through the sizes_dict to create the widths_dict used for image generation.
     for breakpoint_width, (width, units) in sizes_dict.items():
         if units == "px":
             # When px units are defined always generate an image with that width
@@ -287,7 +288,7 @@ def srcset(*args, **kwargs):
     images = []
     for width in reversed(sorted(widths_dict.keys())):
         if not widths_dict[width] and (current_width - width) < threshold:
-            # Only generate required images, images defined with px and images outside our threshold
+            # Only generate required images and images outside our threshold
             continue
 
         current_width = width

setup.cfg

@@ -2,9 +2,10 @@
 [metadata]
 name = django-lazy-srcset
 version = 0.2.2
-description = Lazy srcset and image generation for Django. Minimum effort required. No database required.
+description = Lazy srcset and responsive image generation for Django. Minimum effort required. No database required.
 long_description = file:README.rst
 long_description_content_type = text/x-rst
+url = https://github.com/Quantra/django-lazy-srcset
 author = Vince Coleman
 author_email = [email protected]
 license = MIT