From 752f59fbf364b5388c953cdf3472ae49c2c9bb1b Mon Sep 17 00:00:00 2001 From: Audrey Roy Date: Sun, 14 Jul 2013 19:31:01 +0200 Subject: [PATCH] Initial commit of package template. --- json/project.json | 12 ++ package/.gitignore | 42 ++++++ package/.travis.yml | 15 ++ package/AUTHORS.rst | 13 ++ package/CONTRIBUTING.rst | 82 ++++++++++ package/HISTORY.rst | 9 ++ package/LICENSE | 12 ++ package/MANIFEST.in | 5 + package/README.rst | 26 ++++ package/docs/Makefile | 177 ++++++++++++++++++++++ package/docs/authors.rst | 1 + package/docs/conf.py | 252 +++++++++++++++++++++++++++++++ package/docs/contributing.rst | 1 + package/docs/history.rst | 1 + package/docs/index.rst | 27 ++++ package/docs/installation.rst | 12 ++ package/docs/make.bat | 242 +++++++++++++++++++++++++++++ package/docs/readme.rst | 1 + package/docs/usage.rst | 7 + package/my_proj/__init__.py | 1 + package/my_proj/complexity.py | 112 ++++++++++++++ package/requirements.txt | 0 package/setup.py | 49 ++++++ package/tests/__init__.py | 0 package/tests/input/about.html | 7 + package/tests/input/base.html | 10 ++ package/tests/input/index.html | 7 + package/tests/input/test.json | 1 + package/tests/test_complexity.py | 47 ++++++ package/tox.ini | 9 ++ 30 files changed, 1180 insertions(+) create mode 100644 json/project.json create mode 100644 package/.gitignore create mode 100644 package/.travis.yml create mode 100644 package/AUTHORS.rst create mode 100644 package/CONTRIBUTING.rst create mode 100644 package/HISTORY.rst create mode 100644 package/LICENSE create mode 100644 package/MANIFEST.in create mode 100644 package/README.rst create mode 100644 package/docs/Makefile create mode 100644 package/docs/authors.rst create mode 100644 package/docs/conf.py create mode 100644 package/docs/contributing.rst create mode 100644 package/docs/history.rst create mode 100644 package/docs/index.rst create mode 100644 package/docs/installation.rst create mode 100644 package/docs/make.bat create mode 100644 package/docs/readme.rst create mode 100644 package/docs/usage.rst create mode 100644 package/my_proj/__init__.py create mode 100755 package/my_proj/complexity.py create mode 100644 package/requirements.txt create mode 100755 package/setup.py create mode 100644 package/tests/__init__.py create mode 100644 package/tests/input/about.html create mode 100644 package/tests/input/base.html create mode 100644 package/tests/input/index.html create mode 100644 package/tests/input/test.json create mode 100755 package/tests/test_complexity.py create mode 100644 package/tox.ini diff --git a/json/project.json b/json/project.json new file mode 100644 index 0000000..4bb3cd6 --- /dev/null +++ b/json/project.json @@ -0,0 +1,12 @@ +{ + "full_name": "Audrey Roy", + "email": "audreyr@gmail.com", + "github_username": "audreyr", + "project_name": "A Lot of Effort", + "repo_name": "alotofeffort", + "project_short_description": "Deploy static HTML sites to S3 with the simple 'alotofeffort' command.", + "travis_ci_username": "audreyr", + "release_date": "2013-07-10", + "year": "2013", + "version": "0.1.1", +} \ No newline at end of file diff --git a/package/.gitignore b/package/.gitignore new file mode 100644 index 0000000..2a88a24 --- /dev/null +++ b/package/.gitignore @@ -0,0 +1,42 @@ +*.py[cod] + +# C extensions +*.so + +# Packages +*.egg +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox +nosetests.xml + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# Complexity +output/*.html +output/*/index.html + +# Sphinx +docs/_build diff --git a/package/.travis.yml b/package/.travis.yml new file mode 100644 index 0000000..0c855fa --- /dev/null +++ b/package/.travis.yml @@ -0,0 +1,15 @@ +# Config file for automatic testing at travis-ci.org + +language: python + +python: + - "3.3" + - "2.7" + - "2.6" + - "pypy" + +# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors +install: pip install -r requirements.txt + +# command to run tests, e.g. python setup.py test +script: python setup.py test diff --git a/package/AUTHORS.rst b/package/AUTHORS.rst new file mode 100644 index 0000000..0be547d --- /dev/null +++ b/package/AUTHORS.rst @@ -0,0 +1,13 @@ +======= +Credits +======= + +Development Lead +---------------- + +* {{ project.full_name }} <{{ project.email }}> + +Contributors +------------ + +None yet. Why not be the first? diff --git a/package/CONTRIBUTING.rst b/package/CONTRIBUTING.rst new file mode 100644 index 0000000..dd844c5 --- /dev/null +++ b/package/CONTRIBUTING.rst @@ -0,0 +1,82 @@ +============ +Contributing +============ + +Contributions are welcome! + +Submitting Feedback +------------------- + +The best way to send feedback is to file an issue at https://github.com/{{ project.github_username }}/{{ project.repo_name }}/issues. + +If you are reporting a bug, please include: + +* Your operating system name and version. +* Any details about your local setup that might be helpful in troubleshooting. +* Detailed steps to reproduce the bug. + +If you are proposing a feature: + +* Explain in detail how it would work. +* Keep the scope as narrow as possible, to make it easier to implement. +* Remember that this is a volunteer-driven project, and that contributions + are welcome :) + +Getting Started +--------------- + +Here's how to set up `{{ project.repo_name }}` for local development. + +1. Fork the `{{ project.repo_name }}` repo on GitHub. +2. Clone your fork locally:: + + $ git clone git@github.com:your_name_here/{{ project.repo_name }}.git + +3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: + + $ mkvirtualenv {{ project.repo_name }} + $ cd {{ project.repo_name }}/ + $ python setup.py develop + +4. Create a branch for local development:: + + $ git checkout -b name-of-your-bugfix-or-feature + +Now you can make your changes locally. + +5. When you're done making changes, check that your changes pass flake8 and the +tests, including testing other Python versions with tox:: + + $ flake8 {{ project.repo_name }} tests + $ python setup.py test + $ tox + +To get flake8 and tox, just pip install them into your virtualenv. + +6. Commit your changes and push your branch to GitHub:: + + $ git add . + $ git commit -m "Your detailed description of your changes." + $ git push origin name-of-your-bugfix-or-feature + +7. Submit a pull request through the GitHub website. + +Pull Request Guidelines +----------------------- + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. If the pull request adds functionality, the docs should be updated. Put + your new functionality into a function with a docstring, and add the + feature to the list in README.rst. +3. The pull request should work for Python 2.6+ and 3.3+. Check + https://travis-ci.org/{{ project.travis_ci_username }}/{{ project.repo_name }}/pull_requests and make sure that + the tests pass for all supported Python versions. + +Tips +---- + +To run a subset of tests:: + + $ python -m unittest tests.test_{{ project.repo_name }} diff --git a/package/HISTORY.rst b/package/HISTORY.rst new file mode 100644 index 0000000..4542396 --- /dev/null +++ b/package/HISTORY.rst @@ -0,0 +1,9 @@ +.. :changelog: + +History +------- + +{{ project.version }} ({{ project.release_date }}) +++++++++++++++++++ + +* First release on PyPI. diff --git a/package/LICENSE b/package/LICENSE new file mode 100644 index 0000000..df56303 --- /dev/null +++ b/package/LICENSE @@ -0,0 +1,12 @@ +Copyright (c) {{ project.year }}, {{ project.full_name }} +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +* Neither the name of {{ project.project_name }} nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/package/MANIFEST.in b/package/MANIFEST.in new file mode 100644 index 0000000..f7d4f77 --- /dev/null +++ b/package/MANIFEST.in @@ -0,0 +1,5 @@ +include AUTHORS.rst +include CONTRIBUTING.rst +include HISTORY.rst +include LICENSE +include README.rst diff --git a/package/README.rst b/package/README.rst new file mode 100644 index 0000000..578d927 --- /dev/null +++ b/package/README.rst @@ -0,0 +1,26 @@ +============================= +{{ project.project_name }} +============================= + +{{ project.project_short_description}} + +Documentation +------------- + +The full documentation is at http://{{ project.repo_name }}.rtfd.org. + +Quickstart +---------- + +Using {{ project.project_name }} is easy! Install it:: + + pip install {{ project.repo_name }} + +Then use it in a project:: + + import {{ project.repo_name }} + +Features +-------- + +* TODO diff --git a/package/docs/Makefile b/package/docs/Makefile new file mode 100644 index 0000000..0e35bee --- /dev/null +++ b/package/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# 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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @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 " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @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/complexity.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/complexity.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/complexity" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/complexity" + @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." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @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." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/package/docs/authors.rst b/package/docs/authors.rst new file mode 100644 index 0000000..e122f91 --- /dev/null +++ b/package/docs/authors.rst @@ -0,0 +1 @@ +.. include:: ../AUTHORS.rst diff --git a/package/docs/conf.py b/package/docs/conf.py new file mode 100644 index 0000000..eceb3d1 --- /dev/null +++ b/package/docs/conf.py @@ -0,0 +1,252 @@ +# -*- coding: utf-8 -*- +# +# complexity documentation build configuration file, created by +# sphinx-quickstart on Tue Jul 9 22:26:36 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('.')) + +cwd = os.getcwd() +parent = os.path.dirname(cwd) +sys.path.append(parent) + +# -- 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.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'{{ project.project_name }}' +copyright = u'{{ project.year }}, {{ project.full_name }}' + +# 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 = '{{ project.version }}' +# The full version, including alpha/beta/rc tags. +release = '{{ project.version }}' + +# 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 = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- 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 = '{{ project.repo_name }}doc' + + +# -- 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 = [ + ('index', '{{ project.repo_name }}.tex', u'{{ project.project_name }} Documentation', + u'{{ project.full_name }}', '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 = [ + ('index', '{{ project.repo_name }}', u'{{ project.project_name }} Documentation', + [u'{{ project.full_name }}'], 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 = [ + ('index', '{{ project.repo_name }}', u'{{ project.project_name }} Documentation', + u'{{ project.full_name }}', '{{ project.repo_name }}', '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' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/package/docs/contributing.rst b/package/docs/contributing.rst new file mode 100644 index 0000000..e582053 --- /dev/null +++ b/package/docs/contributing.rst @@ -0,0 +1 @@ +.. include:: ../CONTRIBUTING.rst diff --git a/package/docs/history.rst b/package/docs/history.rst new file mode 100644 index 0000000..2506499 --- /dev/null +++ b/package/docs/history.rst @@ -0,0 +1 @@ +.. include:: ../HISTORY.rst diff --git a/package/docs/index.rst b/package/docs/index.rst new file mode 100644 index 0000000..9b1235d --- /dev/null +++ b/package/docs/index.rst @@ -0,0 +1,27 @@ +.. complexity documentation master file, created by + sphinx-quickstart on Tue Jul 9 22:26:36 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to {{ project.project_name }}'s documentation! +====================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme + installation + usage + contributing + authors + history + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/package/docs/installation.rst b/package/docs/installation.rst new file mode 100644 index 0000000..ee0fb19 --- /dev/null +++ b/package/docs/installation.rst @@ -0,0 +1,12 @@ +============ +Installation +============ + +At the command line:: + + $ easy_install {{ project.repo_name }} + +Or, if you have virtualenvwrapper installed:: + + $ mkvirtualenv {{ project.repo_name }} + $ pip install {{ project.repo_name }} diff --git a/package/docs/make.bat b/package/docs/make.bat new file mode 100644 index 0000000..fec43bb --- /dev/null +++ b/package/docs/make.bat @@ -0,0 +1,242 @@ +@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. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + 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 +) + + +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +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\complexity.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\complexity.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" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF 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 +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/package/docs/readme.rst b/package/docs/readme.rst new file mode 100644 index 0000000..72a3355 --- /dev/null +++ b/package/docs/readme.rst @@ -0,0 +1 @@ +.. include:: ../README.rst diff --git a/package/docs/usage.rst b/package/docs/usage.rst new file mode 100644 index 0000000..9c27051 --- /dev/null +++ b/package/docs/usage.rst @@ -0,0 +1,7 @@ +======== +Usage +======== + +To use {{ project.project_name }} in a project:: + + import {{ project.repo_name }} diff --git a/package/my_proj/__init__.py b/package/my_proj/__init__.py new file mode 100644 index 0000000..05969d6 --- /dev/null +++ b/package/my_proj/__init__.py @@ -0,0 +1 @@ +__version__ = '{{ project.version }}' diff --git a/package/my_proj/complexity.py b/package/my_proj/complexity.py new file mode 100755 index 0000000..8403b31 --- /dev/null +++ b/package/my_proj/complexity.py @@ -0,0 +1,112 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +import errno +import json +import os +import sys + +from jinja2 import FileSystemLoader +from jinja2.environment import Environment + +PY3 = sys.version > '3' +if PY3: + import http.server as httpserver + import socketserver +else: + import SimpleHTTPServer as httpserver + import SocketServer as socketserver + + +def make_sure_path_exists(path): + try: + os.makedirs(path) + except OSError as exception: + if exception.errno != errno.EEXIST: + return False + return True + + +def serve_static_site(): + # Serve the output directory + os.chdir('output/') + PORT = 9090 + Handler = httpserver.SimpleHTTPRequestHandler + httpd = socketserver.TCPServer(("", PORT), Handler) + print("serving at port", PORT) + httpd.serve_forever() + + +def generate_html(pages, context=None, input_dir='input/'): + context = context or {} + env = Environment() + env.loader = FileSystemLoader(input_dir) + + for page in pages: + tmpl = env.get_template('{0}.html'.format(page)) + rendered_html = tmpl.render(**context) + + # Put index in the root. It's a special case. + if page == 'index': + with open('output/index.html', 'w') as fh: + fh.write(rendered_html) + + # Put other pages in page/index.html, for better URL formatting. + else: + make_sure_path_exists('output/{0}/'.format(page)) + with open('output/{0}/index.html'.format(page), 'w') as fh: + fh.write(rendered_html) + + +def generate_context(input_dir='input/'): + """ + Generates the context for all complexity pages. + + Description: + + Iterates through the contents of the input_dir and finds all JSON files. + Loads the JSON file as a Python object with the key being the JSON file name. + + Example: + + Assume the following files exist: + + input/names.json + input/numbers.json + + Depending on their content, might generate a context as follows: + + contexts = {"names": + ['Audrey', 'Danny'] + "numbers": + [1, 2, 3, 4] + } + """ + context = {} + + # Loop through all the JSON files in the input directory + for file_name in [f for f in os.listdir(input_dir) if f.endswith('json')]: + + # Open the JSON file and convert to Python object + obj = json.load(open("{0}/{1}".format(input_dir, file_name))) + + # Add the Python object to the context dictionary + context[file_name[:-5]] = obj + + return context + + +def command_line_runner(): + """ Entry point for the package, as defined in setup.py. """ + + # List the stem of each HTML file in input/ + pages = [f.split('.')[0] for f in os.listdir('input/') if f.endswith('html')] + + context = generate_context() + + # Generate and serve the HTML site + generate_html(pages, context) + serve_static_site() + + +if __name__ == '__main__': + command_line_runner() diff --git a/package/requirements.txt b/package/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/package/setup.py b/package/setup.py new file mode 100755 index 0000000..3331dd0 --- /dev/null +++ b/package/setup.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python + +import os +import sys + +import {{ project.repo_name }} + +try: + from setuptools import setup +except ImportError: + from distutils.core import setup + +if sys.argv[-1] == 'publish': + os.system('python setup.py sdist upload') + sys.exit() + +readme = open('README.rst', 'rt').read() +history = open('HISTORY.rst', 'rt').read() + +setup( + name='{{ project.repo_name }}', + version={{ project.repo_name }}.__version__, + description='{{ project.project_short_description }}', + long_description=readme + '\n\n' + history, + author='{{ project.full_name }}', + author_email='{{ project.email }}', + url='https://github.com/{{ project.github_username }}/{{ project.repo_name }}', + packages=[ + '{{ project.repo_name }}', + ], + include_package_data=True, + install_requires=[ + ], + license="BSD", + zip_safe=False, + keywords='{{ project.repo_name }}', + classifiers=[ + 'Development Status :: 2 - Pre-Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: BSD License', + 'Natural Language :: English', + "Programming Language :: Python :: 2", + 'Programming Language :: Python :: 2.6', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.3', + ], + test_suite='tests', +) diff --git a/package/tests/__init__.py b/package/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/package/tests/input/about.html b/package/tests/input/about.html new file mode 100644 index 0000000..f865a97 --- /dev/null +++ b/package/tests/input/about.html @@ -0,0 +1,7 @@ +{% extends 'base.html' %} + +{% block title %}About{% endblock %} + +{% block content %} +

This is the about page.

+{% endblock %} diff --git a/package/tests/input/base.html b/package/tests/input/base.html new file mode 100644 index 0000000..0a97bfa --- /dev/null +++ b/package/tests/input/base.html @@ -0,0 +1,10 @@ + + + + {% block title %}{% endblock %} - Built with Complexity + + + {% block content %} + {% endblock %} + + \ No newline at end of file diff --git a/package/tests/input/index.html b/package/tests/input/index.html new file mode 100644 index 0000000..31bb707 --- /dev/null +++ b/package/tests/input/index.html @@ -0,0 +1,7 @@ +{% extends 'base.html' %} + +{% block title %}Index{% endblock %} + +{% block content %} +

This is the index page.

+{% endblock %} diff --git a/package/tests/input/test.json b/package/tests/input/test.json new file mode 100644 index 0000000..3c31e3f --- /dev/null +++ b/package/tests/input/test.json @@ -0,0 +1 @@ +{"1": 2} \ No newline at end of file diff --git a/package/tests/test_complexity.py b/package/tests/test_complexity.py new file mode 100755 index 0000000..4fe1154 --- /dev/null +++ b/package/tests/test_complexity.py @@ -0,0 +1,47 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +""" +test_complexity +------------ + +Tests for `complexity` module. +""" + +import os +import shutil +import unittest + +from complexity import complexity + + +class TestComplexity(unittest.TestCase): + + def setUp(self): + # os.chdir('tests/') + os.mkdir('output/') + + def test_make_sure_path_exists(self): + self.assertTrue(complexity.make_sure_path_exists('/usr/')) + self.assertFalse( + complexity.make_sure_path_exists( + '/this-dir-does-not-exist-and-cant-be-created/' + ) + ) + + def test_generate_html(self): + complexity.generate_html(['index', 'about'], context=None, input_dir='tests/input') + self.assertTrue(os.path.isfile('output/index.html')) + self.assertTrue(os.path.isfile('output/about/index.html')) + + def test_generate_context(self): + context = complexity.generate_context(input_dir='tests/input') + self.assertEqual(context, {"test": {"1": 2}}) + + + + def tearDown(self): + shutil.rmtree('output/') + +if __name__ == '__main__': + unittest.main() diff --git a/package/tox.ini b/package/tox.ini new file mode 100644 index 0000000..2a85e82 --- /dev/null +++ b/package/tox.ini @@ -0,0 +1,9 @@ +[tox] +envlist = py26, py27, py33 + +[testenv] +setenv = + PYTHONPATH = {toxinidir}:{toxinidir}/{{ project.repo_name }} +commands = python setup.py test +deps = + -r{toxinidir}/requirements.txt