Commits

Andriy Kornatskyy committed 005ab57

Initial project structure.

Comments (0)

Files changed (17)

+syntax: glob
+build/
+dist/
+env/
+src/*.egg-info/
+.cache
+.coverage
+*.pyc
+*.pyo
+doc/_build
+Copyright (C) 2011 by Andriy Kornatskyy
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+include LICENSE README
+.SILENT: clean env doctest-cover test doc release upload
+.PHONY: clean env doctest-cover test doc release upload
+
+VERSION=2.7
+PYPI=http://pypi.python.org/simple
+DIST_DIR=dist
+
+PYTHON=env/bin/python$(VERSION)
+EASY_INSTALL=env/bin/easy_install-$(VERSION)
+PYTEST=env/bin/py.test-$(VERSION)
+NOSE=env/bin/nosetests-$(VERSION)
+SPHINX=/usr/bin/python /usr/bin/sphinx-build
+
+all: clean doctest-cover test release
+
+debian:
+	apt-get -y update
+	apt-get -y dist-upgrade
+	# How to Compile Python from Source
+	# http://mindref.blogspot.com/2011/09/compile-python-from-source.html
+	apt-get -y install libbz2-dev build-essential python \
+		python-dev python-setuptools python-virtualenv \
+		python-sphinx
+
+env:
+	PYTHON_EXE=/usr/local/bin/python$(VERSION); \
+	if [ ! -x $$PYTHON_EXE ]; then \
+		PYTHON_EXE=/usr/bin/python$(VERSION); \
+	fi;\
+	VIRTUALENV_USE_SETUPTOOLS=1; \
+	export VIRTUALENV_USE_SETUPTOOLS; \
+	virtualenv --python=$$PYTHON_EXE \
+		--no-site-packages env
+	if [ "$$(echo $(VERSION) | sed 's/\.//')" -ge 30 ]; then \
+		echo -n 'Upgrading distribute...'; \
+		$(EASY_INSTALL) -i $(PYPI) -U -O2 distribute \
+			> /dev/null 2>/dev/null; \
+		echo 'done.'; \
+	fi
+	$(EASY_INSTALL) -i $(PYPI) -O2 coverage nose pytest \
+		pytest-pep8 pytest-cov
+	# The following packages available for python < 3.0
+	#if [ "$$(echo $(VERSION) | sed 's/\.//')" -lt 30 ]; then \
+	#fi;
+	$(PYTHON) setup.py develop -i $(PYPI)
+
+clean:
+	find src/ -type d -name __pycache__ | xargs rm -rf
+	find src/ -name '*.py[co]' -delete
+	rm -rf dist/ build/ MANIFEST src/*.egg-info .cache .coverage
+
+release:
+	$(PYTHON) setup.py -q bdist_egg
+
+upload:
+	REV=$$(hg head --template '{rev}');\
+	if [ "$$(echo $(VERSION) | sed 's/\.//')" -eq 27 ]; then \
+		$(PYTHON) setup.py -q egg_info --tag-build .$$REV \
+			sdist register upload; \
+		$(EASY_INSTALL) -i $(PYPI) sphinx; \
+		$(PYTHON) env/bin/sphinx-build -D release=0.1.$$REV \
+			-a -b html doc/ doc/_build/;\
+		python setup.py upload_docs; \
+	fi; \
+	$(PYTHON) setup.py -q egg_info --tag-build .$$REV \
+		bdist_egg --dist-dir=$(DIST_DIR) \
+		rotate --match=$(VERSION).egg --keep=1 --dist-dir=$(DIST_DIR) \
+		upload;
+
+test:
+	$(PYTEST) -q -x --pep8 --doctest-modules \
+		src/wheezy/captcha
+
+doctest-cover:
+	$(NOSE) --stop --with-doctest --detailed-errors \
+		--with-coverage --cover-package=wheezy.captcha
+
+test-cover:
+	$(PYTEST) -q --cov wheezy.caching \
+		--cov-report term-missing \
+		src/wheezy/captcha/tests
+
+doc:
+	$(SPHINX) -a -b html doc/ doc/_build/
+
+test-demos:
+	$(PYTEST) -q -x --pep8 demos/
+`wheezy.captcha`_ is a `python`_ package written in pure Python
+code. It is a lightweight captcha library that provides integration with:
+
+* `PIL`_ - Python Imaging Library 1.1.7.
+
+It is optimized for performance, well tested and documented.
+
+Resources:
+
+* `source code`_, `examples`_ and `issues`_ tracker are available
+  on `bitbucket`_
+* `documentation`_, `readthedocs`_
+* `eggs`_ on `pypi`_
+
+Install
+-------
+
+`wheezy.captcha`_ requires `python`_ version 2.4 to 2.7 or 3.2 (as soon as
+`PIL`_ support released).
+It is independent of operating system. You can install it from `pypi`_
+site using `setuptools`_::
+
+    $ easy_install wheezy.captcha
+
+If you are using `virtualenv`_::
+
+    $ virtualenv env
+    $ env/bin/easy_install wheezy.captcha
+
+If you run into any issue or have comments, go ahead and add on
+`bitbucket`_.
+
+.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.captcha
+.. _`doctest`: http://docs.python.org/library/doctest.html
+.. _`documentation`: http://packages.python.org/wheezy.captcha
+.. _`eggs`: http://pypi.python.org/pypi/wheezy.captcha
+.. _`examples`: http://bitbucket.org/akorn/wheezy.captcha/src/tip/demos
+.. _`issues`: http://bitbucket.org/akorn/wheezy.captcha/issues
+.. _`pil`: http://www.pythonware.com/products/pil/
+.. _`pypi`: http://pypi.python.org
+.. _`python`: http://www.python.org
+.. _`readthedocs`: http://readthedocs.org/builds/wheezycaptcha
+.. _`setuptools`: http://pypi.python.org/pypi/setuptools
+.. _`source code`: http://bitbucket.org/akorn/wheezy.captcha/src
+.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
+.. _`wheezy.captcha`: http://pypi.python.org/pypi/wheezy.captcha
+# -*- coding: utf-8 -*-
+#
+# wheezy.captcha documentation build configuration file, created by
+# sphinx-quickstart on Fri Sep  9 20:36:50 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('.'))
+sys.path.extend([
+	os.path.abspath(os.path.join('..', 'src'))
+])
+
+# -- 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', 'sphinx.ext.doctest',
+    'sphinx.ext.coverage', 'sphinx.ext.viewcode'
+]
+
+# 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'wheezy.captcha'
+copyright = u'2011, Andriy Kornatskyy'
+
+# 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 = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# 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 = ['_build']
+
+# 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 = 'colorful'
+
+# 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'
+
+# The style sheet to use for HTML pages.
+html_style = 'style.css'
+
+# 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 = {
+    'footerbgcolor': '#FFF',
+    'footertextcolor': '#000',
+    'sidebarbgcolor': '#FFF',
+    'sidebartextcolor': '#4d8cbf',
+    'sidebarlinkcolor': '#216093',
+    'relbarbgcolor': '#FFF',
+    'relbartextcolor': '#000',
+    'relbarlinkcolor': '#216093',
+    'bgcolor': '#FFF',
+    'textcolor': '#000',
+    'linkcolor': '#216093',
+    'visitedlinkcolor': '#216093',
+    'headbgcolor': '#FFF',
+    'headtextcolor': '#4d8cbf',
+    'codebgcolor': '#FFF',
+    'codetextcolor': '#060',
+    'bodyfont': 'Georgia, serif',
+    'headfont': 'Calibri, sans-serif',
+	'stickysidebar': True,
+	'externalrefs': True
+}
+
+# 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
+# '<project> v<release> 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 = False
+
+# If true, '(C) Copyright ...' is shown in the HTML footer. Default is True.
+html_show_copyright = False
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> 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 = 'wheezy.captchadoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'wheezy.captcha.tex', u'wheezy.captcha Documentation',
+   u'Andriy Kornatskyy', '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
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# 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 = [
+    ('index', 'wheezy.captcha', u'wheezy.captcha Documentation',
+     [u'Andriy Kornatskyy'], 1)
+]
+
+Examples
+========
+
+We start with a simple example. Before we proceed
+let setup `virtualenv`_ environment::
+
+    $ virtualenv env
+    $ env/bin/easy_install wheezy.captcha
+
+.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv

doc/gettingstarted.rst

+
+Getting Started
+===============
+
+Install
+-------
+
+:ref:`wheezy.captcha` requires `python`_ version 2.4 to 2.7 or 3.2.
+It is independent of operating system. You can install it from `pypi`_
+site using `setuptools`_::
+
+    $ easy_install wheezy.captcha
+
+If you are using `virtualenv`_::
+
+    $ virtualenv env
+    $ env/bin/easy_install wheezy.captcha
+
+Develop
+-------
+
+You can get the `source code`_ using `mercurial`_::
+
+    $ hg clone http://bitbucket.org/akorn/wheezy.captcha
+    $ cd wheezy.captcha
+
+Prepare `virtualenv`_ environment in *env* directory ::
+
+    $ make env
+
+... and run all tests::
+
+    $ make test
+
+You can read how to compile from source code different versions of
+`python`_ in the `article`_ published on `mind reference`_ blog.
+
+You can run certain make targets with specific python version. Here
+we are going to run `doctest`_ with python3.2::
+
+    $ make env doctest-cover VERSION=3.2
+
+Generate documentation with `sphinx`_::
+
+	$ make doc
+
+If you run into any issue or have comments, go ahead and add on
+`bitbucket`_.
+
+.. _`pypi`: http://pypi.python.org/pypi/wheezy.captcha
+.. _`python`: http://www.python.org
+.. _`setuptools`: http://pypi.python.org/pypi/setuptools
+.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.captcha/issues
+.. _`source code`: http://bitbucket.org/akorn/wheezy.captcha/src
+.. _`mercurial`: http://mercurial.selenic.com/
+.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
+.. _`article`: http://mindref.blogspot.com/2011/09/compile-python-from-source.html
+.. _`mind reference`: http://mindref.blogspot.com/
+.. _`doctest`: http://docs.python.org/library/doctest.html
+.. _`sphinx`: http://sphinx.pocoo.org/
+.. _`wheezy.captcha`:
+
+Wheezy Captcha
+==============
+
+Introduction
+------------
+
+:ref:`wheezy.captcha` is a `python`_ package written in pure Python code.
+It is a lightweight captcha library that provides integration with:
+
+* `PIL`_ - Python Imaging Library 1.1.7.
+
+It is optimized for performance, well tested and documented.
+
+Resources:
+
+* `source code`_, `examples`_ and `issues`_ tracker are available
+  on `bitbucket`_
+* `documentation`_, `readthedocs`_
+* `eggs`_ on `pypi`_
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   gettingstarted
+   examples
+   userguide
+   modules
+
+.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.captcha
+.. _`documentation`: http://packages.python.org/wheezy.captcha
+.. _`eggs`: http://pypi.python.org/pypi/wheezy.captcha
+.. _`examples`: http://bitbucket.org/akorn/wheezy.captcha/src/tip/demos
+.. _`issues`: http://bitbucket.org/akorn/wheezy.captcha/issues
+.. _`pil`: http://www.pythonware.com/products/pil/
+.. _`pypi`: http://pypi.python.org
+.. _`python`: http://www.python.org
+.. _`readthedocs`: http://readthedocs.org/builds/wheezycaptcha
+.. _`source code`: http://bitbucket.org/akorn/wheezy.captcha/src
+Modules
+=======
+
+wheezy.caching
+--------------
+
+.. automodule:: wheezy.caching
+   :members:

doc/static/style.css

+@import url("default.css");
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6,
+div.sphinxsidebar h3,
+div.sphinxsidebar h4 {
+    font-weight: bold;
+    border-bottom: none;
+}
+
+pre {
+    line-height: 14pt;
+    margin: 17pt;
+    padding-left: 1em;
+    border: none;
+    border-left: 3px solid #EE9816;
+    font-family: 'Consolas','Deja Vu Sans Mono','Bitstream Vera Sans Mono',monospace;
+    font-size: 0.9em;
+}
+
+div.body p, div.body dd, div.body li {
+    text-align: left;
+}
+
+.highlight {
+    background: #FFF !important;
+}
+
+th.field-name {
+    background: #FFF;
+}
+
+div.related {
+    position: fixed;
+}
+
+div.body {
+    top: 30px;
+    bottom: 0;
+    right: 0;
+    left: 230px;
+    margin: 0;
+    position: fixed;
+    overflow: auto;
+    height: auto;
+}
+
+div.related, div.sphinxsidebar {
+    font-family: Calibri, sans-serif;
+}

doc/userguide.rst

+
+User Guide
+==========
+
+:ref:`wheezy.captcha`...
+[egg_info]
+tag_build=
+tag_date=0
+tag_svn_revision=0
+
+[bdist_egg]
+exclude-source-files=0
+
+[upload_docs]
+upload-dir = doc/_build
+
+[pytest]
+pep8ignore =
+#!/usr/bin/env python
+
+import os
+
+try:
+    from setuptools import setup
+except:
+    from distutils.core import setup
+
+README = open(os.path.join(os.path.dirname(__file__), 'README')).read()
+
+setup(
+    name='wheezy.captcha',
+    version='0.1',
+    description='A lightweight captcha library',
+    long_description=README,
+    url='https://bitbucket.org/akorn/wheezy.captcha',
+
+    author='Andriy Kornatskyy',
+    author_email='andriy.kornatskyy at live.com',
+
+    license='MIT',
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Natural Language :: English',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.4',
+        'Programming Language :: Python :: 2.5',
+        'Programming Language :: Python :: 2.6',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.2',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Programming Language :: Python :: Implementation :: PyPy',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+        'Topic :: Internet :: WWW/HTTP :: WSGI',
+        'Topic :: Internet :: WWW/HTTP :: WSGI :: Application',
+        'Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware',
+        'Topic :: Software Development :: Libraries :: Python Modules'
+    ],
+    keywords='wsgi http captcha',
+    packages=['wheezy', 'wheezy.captcha'],
+    package_dir={'': 'src'},
+    namespace_packages=['wheezy'],
+
+    zip_safe=False,
+    install_requires=[
+        'PIL>=1.1.7'
+    ],
+    extras_require={
+        'dev': [
+            'coverage',
+            'nose',
+            'pytest',
+            'pytest-pep8',
+            'pytest-cov'
+        ]
+    },
+
+    platforms='any'
+)

src/wheezy/__init__.py

+# See
+# http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
+try:
+    __import__('pkg_resources').declare_namespace(__name__)
+except ImportError:
+    from pkgutil import extend_path
+    __path__ = extend_path(__path__, __name__)

src/wheezy/captcha/__init__.py

+
+""" ``captcha`` package.
+"""

src/wheezy/captcha/tests/__init__.py

Empty file added.