commit a74f09e5e996c6fafa528732678ff95f366297fb Author: J. Fernando Sánchez Date: Tue Jan 10 14:06:51 2017 +0100 First commit diff --git a/cookiecutter.json b/cookiecutter.json new file mode 100644 index 0000000..107f16a --- /dev/null +++ b/cookiecutter.json @@ -0,0 +1,9 @@ +{ + "repo_name": "senpy", + "project_short_description": "A simple python project", + "github_username": "balkian", + "full_name": "J. Fernando Sánchez", + "email": "balkian@gmail.com", + "affiliation": "GSI-UPM" + +} diff --git a/{{cookiecutter.repo_name}}/Dockerfile-debug-3.4 b/{{cookiecutter.repo_name}}/Dockerfile-debug-3.4 new file mode 100644 index 0000000..5eb568b --- /dev/null +++ b/{{cookiecutter.repo_name}}/Dockerfile-debug-3.4 @@ -0,0 +1,7 @@ +from python:3.4 + +RUN pip install pytest +ADD requirements.txt /usr/src/app/ +RUN pip install -r /usr/src/app/requirements.txt +ADD dev-requirements.txt /usr/src/app/ +RUN pip install -r /usr/src/app/dev-requirements.txt diff --git a/{{cookiecutter.repo_name}}/Dockerfile.template b/{{cookiecutter.repo_name}}/Dockerfile.template new file mode 100644 index 0000000..3257566 --- /dev/null +++ b/{{cookiecutter.repo_name}}/Dockerfile.template @@ -0,0 +1,5 @@ +{% raw %} +from python:{{PYVERSION}}-onbuild + +RUN pip install . +{% endraw %} diff --git a/{{cookiecutter.repo_name}}/LICENSE.txt b/{{cookiecutter.repo_name}}/LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/{{cookiecutter.repo_name}}/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/{{cookiecutter.repo_name}}/MANIFEST.in b/{{cookiecutter.repo_name}}/MANIFEST.in new file mode 100644 index 0000000..6483491 --- /dev/null +++ b/{{cookiecutter.repo_name}}/MANIFEST.in @@ -0,0 +1,4 @@ +include requirements.txt +include test-requirements.txt +include README.md +include {{ cookiecutter.repo_name }}/VERSION diff --git a/{{cookiecutter.repo_name}}/Makefile b/{{cookiecutter.repo_name}}/Makefile new file mode 100644 index 0000000..1f1a03c --- /dev/null +++ b/{{cookiecutter.repo_name}}/Makefile @@ -0,0 +1,83 @@ +PYVERSIONS=3.4 2.7 +PYMAIN=$(firstword $(PYVERSIONS)) +NAME={{ cookiecutter.repo_name }} +REPO={{ cookiecutter.github_username }} +VERSION=$(shell cat $(NAME)/VERSION) + + +{% raw %} +all: build run + +yapf: + yapf -i -r + +dev: + pip install --user pre-commit + pre-commit install + +dockerfiles: $(addprefix Dockerfile-,$(PYVERSIONS)) + ln -s Dockerfile-$(PYMAIN) Dockerfile + +Dockerfile-%: Dockerfile.template + sed "s/{{PYVERSION}}/$*/" Dockerfile.template > Dockerfile-$* + +build: $(addprefix build-, $(PYMAIN)) + +buildall: $(addprefix build-, $(PYVERSIONS)) + +build-%: Dockerfile-% + docker build -t '$(REPO)/$(NAME):$(VERSION)-python$*' -f Dockerfile-$* .; + +build-debug-%: + docker build -t '$(NAME)-debug' -f Dockerfile-debug-$* .; + +test: $(addprefix test-,$(PYMAIN)) + +testall: $(addprefix test-,$(PYVERSIONS)) + +debug-%: build-debug-% + docker run --rm -w /usr/src/app/ -v $$PWD:/usr/src/app --entrypoint=/bin/bash -ti $(NAME)-debug ; + +debug: debug-$(PYMAIN) + +test-%: build-% + docker run --rm -w /usr/src/app/ --entrypoint=/usr/local/bin/python -ti '$(REPO)/$(NAME):$(VERSION)-python$*' setup.py test --addopts "-vvv -s" ; + +dist/$(NAME)-$(VERSION).tar.gz: + docker run --rm -ti -v $$PWD:/usr/src/app/ -w /usr/src/app/ python:$(PYMAIN) python setup.py sdist; + +sdist: dist/$(NAME)-$(VERSION).tar.gz + +pip_test-%: sdist + docker run --rm -v $$PWD/dist:/dist/ -ti python:$* pip install /dist/$(NAME)-$(VERSION).tar.gz ; + +pip_test: $(addprefix pip_test-,$(PYVERSIONS)) + +upload-%: test-% + docker push '$(REPO)/$(NAME):$(VERSION)-python$*' + +upload: testall $(addprefix upload-,$(PYVERSIONS)) + docker tag '$(REPO)/$(NAME):$(VERSION)-python$(PYMAIN)' '$(REPO)/$(NAME):$(VERSION)' + docker tag '$(REPO)/$(NAME):$(VERSION)-python$(PYMAIN)' '$(REPO)/$(NAME)' + docker push '$(REPO)/$(NAME):$(VERSION)' + +clean: + @docker ps -a | awk '/$(REPO)\/$(NAME)/{ split($$2, vers, "-"); if(vers[1] != "${VERSION}"){ print $$1;}}' | xargs docker rm 2>/dev/null|| true + @docker images | awk '/$(REPO)\/$(NAME)/{ split($$2, vers, "-"); if(vers[1] != "${VERSION}"){ print $$1":"$$2;}}' | xargs docker rmi 2>/dev/null|| true + @docker rmi $(NAME)-debug 2>/dev/null || true + +upload_git: + git commit -a + git tag ${VERSION} + git push --tags origin master + +pip_upload: + python setup.py sdist upload ; + +pip_test: $(addprefix pip_test-,$(PYVERSIONS)) + +run: build + docker run --rm -p 5000:5000 -ti '$(REPO)/$(NAME):$(VERSION)-python$(PYMAIN)' + +.PHONY: test test-% build-% build test test_pip run yapf dev +{% endraw %} diff --git a/{{cookiecutter.repo_name}}/NOTICE b/{{cookiecutter.repo_name}}/NOTICE new file mode 100644 index 0000000..a16cf0e --- /dev/null +++ b/{{cookiecutter.repo_name}}/NOTICE @@ -0,0 +1,13 @@ +Copyright 2016 {{ cookiecutter.full_name }} {{ cookiecutter.affiliation }} + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst new file mode 100644 index 0000000..e69de29 diff --git a/{{cookiecutter.repo_name}}/dev-requirements.txt b/{{cookiecutter.repo_name}}/dev-requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/{{cookiecutter.repo_name}}/docs/Makefile b/{{cookiecutter.repo_name}}/docs/Makefile new file mode 100644 index 0000000..1c9335c --- /dev/null +++ b/{{cookiecutter.repo_name}}/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/Senpy.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Senpy.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/Senpy" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Senpy" + @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/{{cookiecutter.repo_name}}/docs/conf.py b/{{cookiecutter.repo_name}}/docs/conf.py new file mode 100644 index 0000000..6776f1b --- /dev/null +++ b/{{cookiecutter.repo_name}}/docs/conf.py @@ -0,0 +1,274 @@ +# -*- coding: utf-8 -*- +# flake8: noqa +# +# {{cookiecutter.repo_name}} documentation build configuration file, created by +# sphinx-quickstart on Tue Feb 24 08:57:32 2015. +# +# 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 +import 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 ------------------------------------------------ + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +# 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.todo', + 'sphinxcontrib.httpdomain', + 'sphinx.ext.coverage', +] + +# 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'{{cookiecutter.repo_name}}' +copyright = u'2016, {{cookiecutter.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. +with open('../{{cookiecutter.repo_name}}/VERSION') as f: + version = f.read().strip() +# The full version, including alpha/beta/rc tags. +release = 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 ---------------------------------------------- +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +else: + html_theme = 'default' + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. + +# 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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# 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 = '{{cookiecutter.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, or own class]). +latex_documents = [ + ('index', '{{cookiecutter.repo_name}}.tex', u'{{cookiecutter.repo_name}} Documentation', + u'{{cookiecutter.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', '{{cookiecutter.repo_name}}', u'{{cookiecutter.repo_name}} Documentation', + [u'{{cookiecutter.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', '{{cookiecutter.repo_name}}', u'{{cookiecutter.repo_name}} Documentation', + u'{{cookiecutter.full_name}}', '{{cookiecutter.repo_name}}', '{{cookiecutter.project_short_description}}', + '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/{{cookiecutter.repo_name}}/docs/index.rst b/{{cookiecutter.repo_name}}/docs/index.rst new file mode 100644 index 0000000..25ffdd8 --- /dev/null +++ b/{{cookiecutter.repo_name}}/docs/index.rst @@ -0,0 +1,13 @@ +.. {{cookiecutter.repo_name}} documentation master file, created by + sphinx-quickstart on Tue Feb 24 08:57:32 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to {{cookiecutter.repo_name}}'s documentation! +================================= + +Contents: + +.. toctree:: + {{cookiecutter.repo_name}} + :maxdepth: 2 diff --git a/{{cookiecutter.repo_name}}/docs/requirements.txt b/{{cookiecutter.repo_name}}/docs/requirements.txt new file mode 100644 index 0000000..0e47a20 --- /dev/null +++ b/{{cookiecutter.repo_name}}/docs/requirements.txt @@ -0,0 +1 @@ +sphinxcontrib-httpdomain>=1.4 diff --git a/{{cookiecutter.repo_name}}/docs/senpy-architecture.png b/{{cookiecutter.repo_name}}/docs/senpy-architecture.png new file mode 100644 index 0000000..dd1b642 Binary files /dev/null and b/{{cookiecutter.repo_name}}/docs/senpy-architecture.png differ diff --git a/{{cookiecutter.repo_name}}/docs/senpy-playground.png b/{{cookiecutter.repo_name}}/docs/senpy-playground.png new file mode 100644 index 0000000..f0a06cf Binary files /dev/null and b/{{cookiecutter.repo_name}}/docs/senpy-playground.png differ diff --git a/{{cookiecutter.repo_name}}/requirements.txt b/{{cookiecutter.repo_name}}/requirements.txt new file mode 100644 index 0000000..1d9c8e5 --- /dev/null +++ b/{{cookiecutter.repo_name}}/requirements.txt @@ -0,0 +1,2 @@ +future +semver diff --git a/{{cookiecutter.repo_name}}/setup.cfg b/{{cookiecutter.repo_name}}/setup.cfg new file mode 100644 index 0000000..178ba5f --- /dev/null +++ b/{{cookiecutter.repo_name}}/setup.cfg @@ -0,0 +1,9 @@ +[metadata] +description-file = README.rst +[aliases] +test=pytest +[flake8] +# because of the way that future works, we need to call install_aliases before +# finishing the imports. flake8 thinks that we're doing the imports too late, +# but it's actually ok +ignore = E402 diff --git a/{{cookiecutter.repo_name}}/setup.py b/{{cookiecutter.repo_name}}/setup.py new file mode 100644 index 0000000..31f3f6b --- /dev/null +++ b/{{cookiecutter.repo_name}}/setup.py @@ -0,0 +1,50 @@ +import pip +from setuptools import setup +from pip.req import parse_requirements +# parse_requirements() returns generator of pip.req.InstallRequirement objects + +try: + install_reqs = parse_requirements( + "requirements.txt", session=pip.download.PipSession()) + test_reqs = parse_requirements( + "test-requirements.txt", session=pip.download.PipSession()) +except AttributeError: + install_reqs = parse_requirements("requirements.txt") + test_reqs = parse_requirements("test-requirements.txt") + +# reqs is a list of requirement +# e.g. ['django==1.5.1', 'mezzanine==1.4.6'] +install_reqs = [str(ir.req) for ir in install_reqs] +test_reqs = [str(ir.req) for ir in test_reqs] + +from {{ cookiecutter.repo_name }} import __version__ + +setup( + name='{{cookiecutter.repo_name}}', + packages=['{{cookiecutter.repo_name}}'], # this must be the same as the name above + version=__version__, + description='''{{cookiecutter.project_short_description}}''', + author='{{cookiecutter.full_name}}', + author_email='{{cookiecutter.email}}', + url='https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}', # use the URL to the github repo + download_url='https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/archive/{}.tar.gz'.format( + __version__), + package_dir={'{{ cookiecutter.repo_name }}': '{{ cookiecutter.repo_name }}'}, + keywords='{{ cookiecutter.repo_name }}', + install_requires=install_reqs, + tests_require=test_reqs, + setup_requires=['pytest-runner', ], + include_package_data=True, + license='Apache License 2.0', + classifiers=[ + 'Development Status :: 2 - Pre-Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: Apache Software License' + 'Natural Language :: English', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4' +], +) diff --git a/{{cookiecutter.repo_name}}/test-requirements.txt b/{{cookiecutter.repo_name}}/test-requirements.txt new file mode 100644 index 0000000..e079f8a --- /dev/null +++ b/{{cookiecutter.repo_name}}/test-requirements.txt @@ -0,0 +1 @@ +pytest diff --git a/{{cookiecutter.repo_name}}/tests/__init__.py b/{{cookiecutter.repo_name}}/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/{{cookiecutter.repo_name}}/tests/test_{{cookiecutter.repo_name}}.py b/{{cookiecutter.repo_name}}/tests/test_{{cookiecutter.repo_name}}.py new file mode 100644 index 0000000..2605fa3 --- /dev/null +++ b/{{cookiecutter.repo_name}}/tests/test_{{cookiecutter.repo_name}}.py @@ -0,0 +1,19 @@ +""" +Tests for `{{ cookiecutter.repo_name }}` module. +""" +import pytest +from {{ cookiecutter.repo_name }} import {{ cookiecutter.repo_name }} + + +class Test{{ cookiecutter.repo_name|capitalize }}(object): + + @classmethod + def setup_class(cls): + pass + + def test_something(self): + pass + + @classmethod + def teardown_class(cls): + pass diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/VERSION b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/VERSION new file mode 100644 index 0000000..8acdd82 --- /dev/null +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/VERSION @@ -0,0 +1 @@ +0.0.1 diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/__init__.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/__init__.py new file mode 100644 index 0000000..dee2ef8 --- /dev/null +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/__init__.py @@ -0,0 +1,34 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2017 {{ cookiecutter.full_name }} {{ cookiecutter.affiliation }} +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +""" +{{cookiecutter.project_short_description}} +""" + +import semver +from .version import __version__ + +__version_info__ = semver.parse_version_info(__version__) + +if __version_info__.prerelease: + import logging + logger = logging.getLogger(__name__) + msg = 'WARNING: You are using a pre-release version of {} ({})'.format( + __name__, __version__) + if len(logging.root.handlers) > 0: + logger.info(msg) + else: + import sys + print(msg, file=sys.stderr) diff --git a/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/version.py b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/version.py new file mode 100644 index 0000000..8d3f7ec --- /dev/null +++ b/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/version.py @@ -0,0 +1,4 @@ +import os + +with open(os.path.join(os.path.dirname(__file__), 'VERSION')) as f: + __version__ = f.read().strip()