From d6632c95f59e7b57ccd9aedf630c3b1efaf0b292 Mon Sep 17 00:00:00 2001 From: Matthew Tretter Date: Sun, 25 Sep 2011 20:38:43 -0400 Subject: [PATCH] Documentation! --- docs/Makefile | 153 ++++++++++++++ docs/apireference.rst | 15 ++ docs/conf.py | 243 +++++++++++++++++++++++ docs/index.rst | 129 ++++++++++++ docs/make.bat | 190 ++++++++++++++++++ imagekit/__init__.py | 9 - imagekit/management/commands/__init__.py | 1 - imagekit/management/commands/ikflush.py | 7 +- imagekit/models.py | 77 ++++--- imagekit/processors.py | 99 +++++++-- 10 files changed, 866 insertions(+), 57 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/apireference.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..5e9e72d --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = python $(shell which sphinx-build) +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ImageKit.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ImageKit.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/ImageKit" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ImageKit" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/apireference.rst b/docs/apireference.rst new file mode 100644 index 0000000..b203568 --- /dev/null +++ b/docs/apireference.rst @@ -0,0 +1,15 @@ +API Reference +============= + + +:mod:`models` Module +-------------------- + +.. automodule:: imagekit.models + :members: + +:mod:`processors` Module +------------------------ + +.. automodule:: imagekit.processors + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..2f32935 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,243 @@ +# -*- coding: utf-8 -*- +# +# ImageKit documentation build configuration file, created by +# sphinx-quickstart on Sun Sep 25 17:05:55 2011. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'ImageKit' +copyright = u'2011, Matthew Tretter' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '1.0alpha' +# The full version, including alpha/beta/rc tags. +release = '1.0alpha' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ImageKitdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('imagekit', 'ImageKit.tex', u'ImageKit Documentation', + u'Matthew Tretter', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('imagekit', 'imagekit', u'ImageKit Documentation', + [u'Matthew Tretter'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('imagekit', 'ImageKit', u'ImageKit Documentation', u'Matthew Tretter', + 'ImageKit', 'One line description of project.', 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +autoclass_content = 'both' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..2a0c3cf --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,129 @@ +Getting Started +=============== + +ImageKit is a Django app that helps you to add variations of uploaded images to +your models. These variations are called "specs" and can include things like +different sizes (e.g. thumbnails) and black and white versions. + + +Adding Specs to a Model +----------------------- + +Much like :class:`django.db.models.ImageField`, Specs are defined as properties +of a model class:: + + from django.db import models + from imagekit.models import ImageSpec + + class Photo(models.Model): + original_image = models.ImageField(upload_to'photos') + formatted_image = ImageSpec(image_field='original_image', format='JPEG', + quality=90) + +Accessing the spec through a model instance will create the image and return an +ImageFile-like object (just like with a normal +:class:`django.db.models.ImageField`):: + + photo = Photo.objects.all()[0] + photo.original_image.url # > '/media/photos/birthday.tiff' + photo.formatted_image.url # > '/media/cache/photos/birthday_formatted_image.jpeg' + +Check out :class:`imagekit.models.ImageSpec` for more information. + + +Processors +---------- + +The real power of ImageKit comes from processors. Processors take an image, do +something to it, and return the result. By providing a list of processors to +your spec, you can expose different versions of the original image:: + + from django.db import models + from imagekit.models import ImageSpec + from imagekit.processors import Crop, Adjust + + class Photo(models.Model): + original_image = models.ImageField(upload_to'photos') + thumbnail = ImageSpec([Adjust(contrast=1.2, sharpness=1.1), Crop(50, 50)], + image_field='original_image', format='JPEG', quality=90) + +The ``thumbnail`` property will now return a cropped image:: + + photo = Photo.objects.all()[0] + photo.thumbnail.url # > '/media/cache/photos/birthday_thumbnail.jpeg' + photo.thumbnail.width # > 50 + photo.original_image.width # > 1000 + +The original image is not modified; ``thumbnail`` is a new file that is the +result of running the :class:`imagekit.processors.Crop` processor on the +original. + +The :mod:`imagekit.processors` module contains processors for many common +image manipulations, like resizing, rotating, and color adjustments. However, if +they aren't up to the task, you can create your own. All you have to do is +implement a ``process()`` method:: + + class Watermark(object): + def process(self, image): + # Code for adding the watermark goes here. + return image + + class Photo(models.Model): + original_image = models.ImageField(upload_to'photos') + watermarked_image = ImageSpec([Watermark()], image_field='original_image', + format='JPEG', quality=90) + + +Admin +----- + +ImageKit also contains a class named :class:`imagekit.models.AdminThumbnailView` +for displaying specs (or even regular ImageFields) in the +`Django admin change list`__. Like :class:`imagekit.models.ImageSpec`, +AdminThumbnailView is used as a property on Django model classes:: + + from django.db import models + from imagekit.models import ImageSpec + from imagekit.processors import Crop, AdminThumbnailView + + class Photo(models.Model): + original_image = models.ImageField(upload_to'photos') + thumbnail = ImageSpec([Crop(50, 50)], image_field='original_image') + admin_thumbnail_view = AdminThumbnailView(image_field='thumbnail') + +You can then then add this property to the `list_display`__ field of your admin +class:: + + from django.contrib import admin + from .models import Photo + + + class PhotoAdmin(admin.ModelAdmin): + list_display = ('__str__', 'admin_thumbnail_view') + + + admin.site.register(Photo, PhotoAdmin) + +AdminThumbnailView can even use a custom template. For more information, see +:class:`imagekit.models.AdminThumbnailView`. + + +Commands +-------- + +.. automodule:: imagekit.management.commands.ikflush + + + + + +Digging Deeper +-------------- + +.. toctree:: + + apireference + + +__ https://docs.djangoproject.com/en/dev/intro/tutorial02/#customize-the-admin-change-list +__ https://docs.djangoproject.com/en/dev/ref/contrib/admin/#django.contrib.admin.ModelAdmin.list_display \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..aad0d30 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,190 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ImageKit.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ImageKit.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end diff --git a/imagekit/__init__.py b/imagekit/__init__.py index 0540878..9a68e39 100644 --- a/imagekit/__init__.py +++ b/imagekit/__init__.py @@ -1,11 +1,2 @@ -""" -Django ImageKit - -Author: Justin Driscoll -Version: 0.3.6 - -""" __author__ = 'Justin Driscoll, Bryan Veloso, Greg Newman, Chris Drackett' __version__ = (0, 3, 6) - - diff --git a/imagekit/management/commands/__init__.py b/imagekit/management/commands/__init__.py index 8b13789..e69de29 100644 --- a/imagekit/management/commands/__init__.py +++ b/imagekit/management/commands/__init__.py @@ -1 +0,0 @@ - diff --git a/imagekit/management/commands/ikflush.py b/imagekit/management/commands/ikflush.py index fd26dd4..b1799cc 100644 --- a/imagekit/management/commands/ikflush.py +++ b/imagekit/management/commands/ikflush.py @@ -1,3 +1,7 @@ +"""Flushes the cached ImageKit images. + +""" + from django.db.models.loading import cache from django.core.management.base import BaseCommand, CommandError from optparse import make_option @@ -14,9 +18,6 @@ class Command(BaseCommand): return flush_cache(args, options) def flush_cache(apps, options): - """ Clears the image cache - - """ apps = [a.strip(',') for a in apps] if apps: for app_label in apps: diff --git a/imagekit/models.py b/imagekit/models.py index bf6007b..e3471f2 100755 --- a/imagekit/models.py +++ b/imagekit/models.py @@ -30,30 +30,45 @@ class _ImageSpecMixin(object): class ImageSpec(_ImageSpecMixin): - - _upload_to_attr = 'cache_to' - - cache_to = None - """Specifies the filename to use when saving the image cache file. This is - modeled after ImageField's `upload_to` and can accept either a string - (that specifies a directory) or a callable (that returns a filepath). - Callable values should accept the following arguments: - - instance -- the model instance this spec belongs to - path -- the path of the original image - specname -- the property name that the spec is bound to on the model instance - extension -- a recommended extension. If the format of the spec is set - explicitly, this suggestion will be based on that format. if not, - the extension of the original file will be passed. You do not have - to use this extension, it's only a recommendation. - - If you have not explicitly set a format on your ImageSpec, the extension of - the path returned by this function will be used to infer one. + """The heart and soul of the ImageKit library, ImageSpec allows you to add + variants of uploaded images to your models. """ + _upload_to_attr = 'cache_to' + def __init__(self, processors=None, quality=70, format=None, image_field=None, pre_cache=False, storage=None, cache_to=None): + """ + :param processors: A list of processors to run on the original image. + :param quality: The quality of the output image. This option is only + used for the JPEG format. + :param format: The format of the output file. If not provided, ImageSpec + will try to guess the appropriate format based on the extension + of the filename and the format of the input image. + :param image_field: The name of the model property that contains the + original image. + :param pre_cache: A boolean that specifies whether the image should be + generated immediately (True) or on demand (False). + :param storage: A Django storage system to use to save the generated + image. + :param cache_to: Specifies the filename to use when saving the image + cache file. This is modeled after ImageField's ``upload_to`` and + can be either a string (that specifies a directory) or a + callable (that returns a filepath). Callable values should + accept the following arguments: + + - instance -- The model instance this spec belongs to + - path -- The path of the original image + - specname -- the property name that the spec is bound to on + the model instance + - extension -- A recommended extension. If the format of the + spec is set explicitly, this suggestion will be + based on that format. if not, the extension of the + original file will be passed. You do not have to use + this extension, it's only a recommendation. + + """ _ImageSpecMixin.__init__(self, processors, quality=quality, format=format) @@ -285,15 +300,18 @@ def _post_delete_handler(sender, instance=None, **kwargs): class AdminThumbnailView(object): + """A convenience utility for adding thumbnails to the Django admin change + list. + + """ short_description = _('Thumbnail') allow_tags = True def __init__(self, image_field, template=None): """ - Keyword arguments: - image_field -- the name of the ImageField or ImageSpec on the model to - use for the thumbnail. - template -- the template with which to render the thumbnail + :param image_field: The name of the ImageField or ImageSpec on the model + to use for the thumbnail. + :param template: The template with which to render the thumbnail """ self.image_field = image_field @@ -341,12 +359,25 @@ class ProcessedImageFieldFile(ImageFieldFile, _ImageSpecFileMixin): class ProcessedImageField(models.ImageField, _ImageSpecMixin): + """ProcessedImageField is an ImageField that runs processors on the uploaded + image *before* saving it to storage. This is in contrast to specs, which + maintain the original. Useful for coercing fileformats or keeping images + within a reasonable size. + + """ _upload_to_attr = 'upload_to' attr_class = ProcessedImageFieldFile def __init__(self, processors=None, quality=70, format=None, verbose_name=None, name=None, width_field=None, height_field=None, **kwargs): + """ + The ProcessedImageField constructor accepts all of the arguments that + the :class:`django.db.models.ImageField` constructor accepts, as well as + the ``processors``, ``format``, and ``quality`` arguments of + :class:`imagekit.models.ImageSpec`. + + """ _ImageSpecMixin.__init__(self, processors, quality=quality, format=format) diff --git a/imagekit/processors.py b/imagekit/processors.py index 1e22ec5..38f374d 100644 --- a/imagekit/processors.py +++ b/imagekit/processors.py @@ -10,16 +10,16 @@ from imagekit.lib import * class ImageProcessor(object): - """ Base image processor class """ - def process(self, img): return img class ProcessorPipeline(ImageProcessor, list): - """A processor that just runs a bunch of other processors. This class allows - any object that knows how to deal with a single processor to deal with a - list of them. + """A :class:`list` of other processors. This class allows any object that + knows how to deal with a single processor to deal with a list of them. + For example:: + + processed_image = ProcessorPipeline([ProcessorA(), ProcessorB()]).process(image) """ def process(self, img): @@ -29,8 +29,28 @@ class ProcessorPipeline(ImageProcessor, list): class Adjust(ImageProcessor): - + """Performs color, brightness, contrast, and sharpness enhancements on the + image. See :mod:`PIL.ImageEnhance` for more imformation. + + """ def __init__(self, color=1.0, brightness=1.0, contrast=1.0, sharpness=1.0): + """ + :param color: A number between 0 and 1 that specifies the saturation of + the image. 0 corresponds to a completely desaturated image + (black and white) and 1 to the original color. + See :class:`PIL.ImageEnhance.Color` + :param brightness: A number representing the brightness; 0 results in a + completely black image whereas 1 corresponds to the brightness + of the original. See :class:`PIL.ImageEnhance.Brightness` + :param contrast: A number representing the contrast; 0 results in a + completely gray image whereas 1 corresponds to the contrast of + the original. See :class:`PIL.ImageEnhance.Contrast` + :param sharpness: A number representing the sharpness; 0 results in a + blurred image; 1 corresponds to the original sharpness; 2 + results in a sharpened image. See + :class:`PIL.ImageEnhance.Sharpness` + + """ self.color = color self.brightness = brightness self.contrast = contrast @@ -49,6 +69,9 @@ class Adjust(ImageProcessor): class Reflection(ImageProcessor): + """Creates an image with a reflection. + + """ background_color = '#FFFFFF' size = 0.0 opacity = 0.6 @@ -104,6 +127,9 @@ class _Resize(ImageProcessor): class Crop(_Resize): + """Resizes an image , cropping it to the specified width and height. + + """ TOP_LEFT = 'tl' TOP = 't' @@ -128,6 +154,23 @@ class Crop(_Resize): } def __init__(self, width=None, height=None, anchor=None): + """ + :param width: The target width, in pixels. + :param height: The target height, in pixels. + :param anchor: Specifies which part of the image should be retained when + cropping. Valid values are: + + - Crop.TOP_LEFT + - Crop.TOP + - Crop.TOP_RIGHT + - Crop.LEFT + - Crop.CENTER + - Crop.RIGHT + - Crop.BOTTOM_LEFT + - Crop.BOTTOM + - Crop.BOTTOM_RIGHT + + """ super(Crop, self).__init__(width, height) self.anchor = anchor @@ -155,7 +198,19 @@ class Crop(_Resize): class Fit(_Resize): + """Resizes an image to fit within the specified dimensions. + + """ + def __init__(self, width=None, height=None, upscale=None): + """ + :param width: The maximum width of the desired image. + :param height: The maximum height of the desired image. + :param upscale: A boolean value specifying whether the image should be + enlarged if its dimensions are smaller than the target + dimensions. + + """ super(Fit, self).__init__(width, height) self.upscale = upscale @@ -182,21 +237,6 @@ class Fit(_Resize): class Transpose(ImageProcessor): """ Rotates or flips the image - Possible arguments: - - Transpose.AUTO - - Transpose.FLIP_HORIZONTAL - - Transpose.FLIP_VERTICAL - - Transpose.ROTATE_90 - - Transpose.ROTATE_180 - - Transpose.ROTATE_270 - - The order of the arguments dictates the order in which the Transposition - steps are taken. - - If Transpose.AUTO is present, all other arguments are ignored, and the - processor will attempt to rotate the image according to the - EXIF Orientation data. - """ AUTO = 'auto' FLIP_HORIZONTAL = Image.FLIP_LEFT_RIGHT @@ -218,6 +258,23 @@ class Transpose(ImageProcessor): } def __init__(self, *args): + """ + Possible arguments: + - Transpose.AUTO + - Transpose.FLIP_HORIZONTAL + - Transpose.FLIP_VERTICAL + - Transpose.ROTATE_90 + - Transpose.ROTATE_180 + - Transpose.ROTATE_270 + + The order of the arguments dictates the order in which the Transposition + steps are taken. + + If Transpose.AUTO is present, all other arguments are ignored, and the + processor will attempt to rotate the image according to the + EXIF Orientation data. + + """ super(Transpose, self).__init__() if args: self.methods = args