Changeset - ead70abc037d
[Not reviewed]
0.2
0 3 0
Branko Majic (branko) - 11 years ago 2014-12-14 23:58:26
branko@majic.rs
Noticket: Preparing for 0.2 release.
3 files changed with 15 insertions and 3 deletions:
0 comments (0 inline, 0 general)
docs/conf.py
Show inline comments
 
# -*- coding: utf-8 -*-
 
#
 
# Pydenticon documentation build configuration file, created by
 
# sphinx-quickstart on Mon Nov 25 23:13:33 2013.
 
#
 
# 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.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', 'sphinx.ext.doctest']
 

	
 
# 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'Pydenticon'
 
copyright = u'2013, Branko Majic'
 

	
 
# 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.1'
 
version = '0.2'
 
# The full version, including alpha/beta/rc tags.
 
release = '0.1.1'
 
release = '0.2'
 

	
 
# 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 = '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
 
# "<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 = "images/logo.png"
 

	
 
# 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 = "images/favicon.ico"
 

	
 
# 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.
docs/releasenotes.rst
Show inline comments
 
Release Notes
 
=============
 

	
 
0.2
 
---
 

	
 
A small release that adds support for Python 3 in addition to Python 2.7.
 

	
 
New features:
 

	
 
* `PYD-5: Add support for Python 3.x
 
  <https://projects.majic.rs/pydenticon/issues/PYD-5>`_
 

	
 
  Support for Python 3.x, in addition to Python 2.7.
 

	
 
0.1.1
 
-----
 

	
 
This is a very small release feature-wise, with a single bug-fix.
 

	
 
New features:
 

	
 
* `PYD-3: Initial tests <https://projects.majic.rs/pydenticon/issues/PYD-3>`_
 

	
 
  Unit tests covering most of the library functionality.
 

	
 
Bug fixes:
 

	
 
* `PYD-4: Identicon generation using pre-hashed data raises ValueError
 
  <https://projects.majic.rs/pydenticon/issues/PYD-4>`_
 

	
 
  Fixed some flawed logic which prevented identicons to be generated from
 
  existing hashes.
 

	
 
0.1
 
---
 

	
 
Initial release of Pydenticon. Implemented features:
 

	
 
* Supported parameters for identicon generator (shared between multiple
 
  identicons):
 
  * Number of blocks in identicon (rows and columns).
 
  * Digest algorithm.
 
  * List of foreground colours to choose from.
 
  * Background colour.
 
* Supported parameters when generating induvidual identicons:
 
  * Data that should be used for identicon generation.
 
  * Width and height of resulting image in pixels.
 
  * Padding around identicon (top, bottom, left, right).
 
  * Output format.
 
  * Inverted identicon (swaps foreground with background).
 
* Support for PNG and ASCII format of resulting identicons.
 
* Full documentation covering installation, usage, algorithm, privacy. API
 
  reference included as well.
setup.py
Show inline comments
 
import os
 
from setuptools import setup
 

	
 
README = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()
 
INSTALL_REQUIREMENTS = ["Pillow"]
 
TEST_REQUIREMENTS = ["mock"]
 

	
 
# allow setup.py to be run from any path
 
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
 

	
 
setup(
 
    name='pydenticon',
 
    version='0.2-dev',
 
    version='0.2',
 
    packages=['pydenticon'],
 
    include_package_data=True,
 
    license='BSD',  # example license
 
    description='Library for generating identicons. Port of Sigil (https://github.com/cupcake/sigil) with enhancements.',
 
    long_description=README,
 
    url='https://github.com/azaghal/pydenticon',
 
    author='Branko Majic',
 
    author_email='branko@majic.rs',
 
    install_requires=INSTALL_REQUIREMENTS,
 
    tests_require=TEST_REQUIREMENTS,
 
    test_suite="tests",
 
    classifiers=[
 
        'Environment :: Other Environment',
 
        'Environment :: Web Environment',
 
        'Intended Audience :: Developers',
 
        'License :: OSI Approved :: BSD License',
 
        'Operating System :: OS Independent',
 
        'Programming Language :: Python',
 
        'Programming Language :: Python :: 2.7',
 
        'Programming Language :: Python :: 3',
 
        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
 
        'Topic :: Multimedia :: Graphics',
 
        'Topic :: Software Development :: Libraries',
 
    ],
 
)
0 comments (0 inline, 0 general)