openstack/deb-python-colander
Code Issues Proposed changes

- Moved to Pylons Project GitHub (https://github.com/Pylons/colander).

Browse Source 
- Add tox.ini for testing purposes.
This commit is contained in:
Chris McDonough
2011-02-16 01:04:40 -05:00
parent 5dab4e22c2
commit c57ada4437
9 changed files with 110 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
.gitignore vendored Normal file
View File

@@ -0,0 +1,19 @@
*.egg
*.egg-info
*.pyc
*$py.class
*.pt.py
*.txt.py
*~
.coverage
.tox/
nosetests.xml
env26/
env25/
env24/
env27/
jyenv/
pypyenv/
build/
dist/
colander/coverage.xml

4
CHANGES.txt
View File

@@ -4,6 +4,10 @@ Changes
Next release Next release
------------ ------------
- Moved to Pylons Project GitHub (https://github.com/Pylons/colander).
- Add tox.ini for testing purposes.
- New API: ``colander.required``. Used as the marker value when a - New API: ``colander.required``. Used as the marker value when a
``missing`` argument is left unspecified. ``missing`` argument is left unspecified.

2
COPYRIGHT.txt
View File

@@ -1,3 +1,3 @@
Copyright (c) 2010 Agendaless Consulting and Contributors. Copyright (c) 2011 Agendaless Consulting and Contributors.
(http://www.agendaless.com), All Rights Reserved (http://www.agendaless.com), All Rights Reserved

4
README.txt
View File

@@ -9,5 +9,5 @@ An extensible package which can be used to:
- serialize an arbitrary data structure to a data structure composed - serialize an arbitrary data structure to a data structure composed
of strings, mappings, and lists. of strings, mappings, and lists.
Please see `http://docs.repoze.org/colander Please see http://docs.pylonsproject.org/colander/dev/
<http://docs.repoze.org/colander>`_ for further documentation. for further documentation.

2
docs/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
_build/
_themes/

62
docs/Makefile
View File

@@ -9,7 +9,7 @@ PAPER =
# Internal variables. # Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck .PHONY: help clean html web pickle htmlhelp latex changes linkcheck
@@ -23,48 +23,66 @@ help:
@echo " linkcheck to check all external links for integrity" @echo " linkcheck to check all external links for integrity"
clean: clean:
-rm -rf .build/* -rm -rf _build/*
html: html: _themes/
mkdir -p .build/html .build/doctrees mkdir -p _build/html _build/doctrees
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
@echo @echo
@echo "Build finished. The HTML pages are in .build/html." @echo "Build finished. The HTML pages are in _build/html."
text:
mkdir -p _build/text _build/doctrees
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text
@echo
@echo "Build finished. The HTML pages are in _build/text."
pickle: pickle:
mkdir -p .build/pickle .build/doctrees mkdir -p _build/pickle _build/doctrees
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
@echo @echo
@echo "Build finished; now you can process the pickle files or run" @echo "Build finished; now you can process the pickle files or run"
@echo " sphinx-web .build/pickle" @echo " sphinx-web _build/pickle"
@echo "to start the sphinx-web server." @echo "to start the sphinx-web server."
web: pickle web: pickle
htmlhelp: htmlhelp: _themes
mkdir -p .build/htmlhelp .build/doctrees mkdir -p _build/htmlhelp _build/doctrees
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
@echo @echo
@echo "Build finished; now you can run HTML Help Workshop with the" \ @echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in .build/htmlhelp." ".hhp project file in _build/htmlhelp."
latex: latex:
mkdir -p .build/latex .build/doctrees mkdir -p _build/latex _build/doctrees
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
cp _static/*.png _build/latex
./convert_images.sh
cp _static/latex-warning.png _build/latex
cp _static/latex-note.png _build/latex
@echo @echo
@echo "Build finished; the LaTeX files are in .build/latex." @echo "Build finished; the LaTeX files are in _build/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex." "run these through (pdf)latex."
changes: changes:
mkdir -p .build/changes .build/doctrees mkdir -p _build/changes _build/doctrees
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
@echo @echo
@echo "The overview file is in .build/changes." @echo "The overview file is in _build/changes."
linkcheck: linkcheck:
mkdir -p .build/linkcheck .build/doctrees mkdir -p _build/linkcheck _build/doctrees
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
@echo @echo
@echo "Link check complete; look for any errors in the above output " \ @echo "Link check complete; look for any errors in the above output " \
"or in .build/linkcheck/output.txt." "or in _build/linkcheck/output.txt."
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) _build/epub
@echo
@echo "Build finished. The epub file is in _build/epub."
_themes:
git clone git://github.com/Pylons/pylons_sphinx_theme.git _themes

14
docs/conf.py
View File

@@ -46,7 +46,7 @@ master_doc = 'index'
# General substitutions. # General substitutions.
project = 'colander' project = 'colander'
copyright = '2010, Repoze Developers <repoze-dev@lists.repoze.org>' copyright = '2010, Agendaless Consulting <pylons-discuss@googlegroups.com>'
# The default replacements for |version| and |release|, also used in various # The default replacements for |version| and |release|, also used in various
# other places throughout the built documents. # other places throughout the built documents.
@@ -91,10 +91,14 @@ pygments_style = 'sphinx'
# Options for HTML output # Options for HTML output
# ----------------------- # -----------------------
sys.path.append(os.path.abspath('_themes'))
html_theme_path = ['_themes']
html_theme = 'pylons'
# The style sheet to use for HTML and HTML Help pages. A file of that name # The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths # must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path. # given in html_static_path.
html_style = 'repoze.css' #html_style = 'pylons.css'
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
@@ -106,7 +110,7 @@ html_style = 'repoze.css'
# The name of an image file (within the static path) to place at the top of # The name of an image file (within the static path) to place at the top of
# the sidebar. # the sidebar.
html_logo = '.static/logo_hi.gif' #html_logo = '.static/logo_hi.gif'
# The name of an image file (within the static path) to use as favicon of # 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 # the docs. This file should be a Windows icon file (.ico) being 16x16 or
@@ -117,7 +121,7 @@ html_logo = '.static/logo_hi.gif'
# here, relative to this directory. They are copied after the builtin # here, relative to this directory. They are copied after the builtin
# static files, so a file named "default.css" will overwrite the builtin # static files, so a file named "default.css" will overwrite the builtin
# "default.css". # "default.css".
html_static_path = ['.static'] #html_static_path = ['.static']
# If not '', a 'Last updated on:' timestamp is inserted at every page # If not '', a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format. # bottom, using the given strftime format.
@@ -173,7 +177,7 @@ htmlhelp_basename = 'atemplatedoc'
# author, document class [howto/manual]). # author, document class [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'atemplate.tex', 'colander Documentation', ('index', 'atemplate.tex', 'colander Documentation',
'Repoze Developers', 'manual'), 'Pylons Developers', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the # The name of an image file (relative to this directory) to place at the

15
setup.py
View File

@@ -1,6 +1,6 @@
############################################################################## ##############################################################################
# #
# Copyright (c) 2010 Agendaless Consulting and Contributors. # Copyright (c) 2011 Agendaless Consulting and Contributors.
# All Rights Reserved. # All Rights Reserved.
# #
# This software is subject to the provisions of the BSD-like license at # This software is subject to the provisions of the BSD-like license at
@@ -18,8 +18,13 @@ from setuptools import setup
from setuptools import find_packages from setuptools import find_packages
here = os.path.abspath(os.path.dirname(__file__)) here = os.path.abspath(os.path.dirname(__file__))
README = open(os.path.join(here, 'README.txt')).read()
CHANGES = open(os.path.join(here, 'CHANGES.txt')).read() try:
README = open(os.path.join(here, 'README.txt')).read()
CHANGES = open(os.path.join(here, 'CHANGES.txt')).read()
except:
README = ''
CHANGES = ''
requires = ['iso8601', 'translationstring'] requires = ['iso8601', 'translationstring']
@@ -34,8 +39,8 @@ setup(name='colander',
], ],
keywords='serialize deserialize validate schema validation', keywords='serialize deserialize validate schema validation',
author="Agendaless Consulting", author="Agendaless Consulting",
author_email="repoze-dev@lists.repoze.org", author_email="pylons-discuss@googlegroups.com",
url="http://docs.repoze.org/colander", url="http://docs.pylonsproject.org/colander/dev/",
license="BSD-derived (http://www.repoze.org/LICENSE.txt)", license="BSD-derived (http://www.repoze.org/LICENSE.txt)",
packages=find_packages(), packages=find_packages(),
include_package_data=True, include_package_data=True,

23
tox.ini Normal file
View File

@@ -0,0 +1,23 @@
[tox]
envlist =
py24,py25,py26,py27,jython,pypy,cover
[testenv]
commands =
python setup.py test -q
[testenv:cover]
basepython =
python2.6
commands =
python setup.py nosetests --with-xunit --with-xcoverage
deps =
nose
coverage<3.4
nosexcover
# we separate coverage into its own testenv because a) "last run wins" wrt
# cobertura jenkins reporting and b) pypy and jython can't handle any
# combination of versions of coverage and nosexcover that i can find.
# coverage <3.4 is required by nosexcover 1.0.4.