Bug Fix for basicpackage

MANIFEST.in

@@ -17,24 +17,8 @@ include docs/overview.rst
 include setup.py
 include skeleton/__init__.py
 include skeleton/core.py
-include skeleton/examples/__init__.py
-include skeleton/examples/basic-module/README.rst
-include skeleton/examples/basic-module/setup.py_tmpl
-include skeleton/examples/basic-module/{module_name}.py
-include skeleton/examples/basic-package/MANIFEST.in
-include skeleton/examples/basic-package/README.rst
-include skeleton/examples/basic-package/distribute_setup.py
-include skeleton/examples/basic-package/setup.py_tmpl
-include skeleton/examples/basicpackage.py
-include skeleton/examples/licenses.py
-include skeleton/examples/licenses/bsd/LICENSE_tmpl
-include skeleton/examples/licenses/gpl/COPYING
-include skeleton/examples/licenses/gpl/LICENSE_tmpl
-include skeleton/examples/licenses/lgpl/COPYING
-include skeleton/examples/licenses/lgpl/COPYING.LESSER
-include skeleton/examples/licenses/lgpl/LICENSE_tmpl
-include skeleton/examples/licenses/no-license/LICENSE_tmpl
-include skeleton/examples/mkmodule.py
+recursive-include skeleton/examples *
+recursive-exclude skeleton/examples *.pyc
 include skeleton/tests/__init__.py
 include skeleton/tests/skeletons/dynamic-content/bar/baz.txt_tmpl
 include skeleton/tests/skeletons/dynamic-content/foo.txt

setup.py

@@ -22,7 +22,7 @@ def read_file(name):
 
 
 PROJECT = 'skeleton'
-VERSION = '0.6'
+VERSION = '0.6.1'
 URL = 'http://dinoboff.github.com/skeleton'
 AUTHOR = 'Damien Lebrun'
 AUTHOR_EMAIL = 'dinoboff@gmail.com'
@@ -58,6 +58,11 @@ def read_file(name):
         'virtualenvwrapper.project.template': [
             'package = skeleton.examples.basicpackage:virtualenv_warpper_hook',
             ],
+       'console_scripts': [
+            'skeleton_module = skeleton.examples.mkmodule:main',
+            'skeleton_package = skeleton.examples.basicpackage:main',
+            'skeleton_package_sphinx = skeleton.examples.sphinxpackage:main',
+            ],
         },
     classifiers=[
         'Development Status :: 4 - Beta',

skeleton/examples/basic-package/MANIFEST.in

@@ -1,4 +1,5 @@
 include MANIFEST.in
 include README.rst
+include LICENSE
 include distribute_setup.py
-include setup.py
+include setup.py

skeleton/examples/basic-package/setup.py_tmpl

@@ -34,7 +34,6 @@ setup(
     license=read_file('LICENSE'),
     namespace_packages={ns_packages!r},
     packages={packages!r},
-    package_dir = {{'': os.path.dirname(__file__)}},
     include_package_data=True,
     zip_safe=False,
     install_requires=[

skeleton/examples/sphinx-package/HISTORY

@@ -0,0 +1,3 @@
+History
+=======
+

skeleton/examples/sphinx-package/INSTALL_tmpl

@@ -0,0 +1,62 @@
+========
+Installation
+========
+
+{project_name} uses distribute for installation therefore it may be installed
+using:
+
+* from source on the command-line or
+* from pypi using pip or easy_install.
+
+From source
+-----------
+
+1) Download the source distribution of {project_name}.
+2) Unzip the distribution into a directory.
+3) cd into that directory and type the following command (assuming python 
+   is in your path (on Linux systems root access may be required)
+
+   .. code-block:: sh
+
+      > python setup.py install
+
+4) {project_name} should now be available inside you system python as
+
+   .. code-block:: py
+
+      >>> import {package_name}
+
+From pypi
+---------
+
+1) type the following command (assuming pip 
+   is in your path (on Linux systems root access may be required)
+
+   .. code-block:: sh
+
+      > pip install {project_name}
+
+4) {project_name} should now be available inside you system python as
+
+   .. code-block:: py
+
+      >>> import {package_name}
+
+
+Documentation
+-------------
+
+{project_name} uses sphinx for its documentation. Please install spinx either
+via pip or easy_install or from your package mangement system.
+
+To use sphinx to build the documentation
+from source use the following command from the root directory of the project
+
+.. code-block:: sh
+
+   > python setup.py build_sphinx
+
+The resulting html files will be in docs/build/html
+
+
+

skeleton/examples/sphinx-package/MANIFEST.in

@@ -0,0 +1,10 @@
+include MANIFEST.in
+include README
+include HISTORY
+include VERSION
+include INSTALL
+include LICENSE
+include distribute_setup.py
+include setup.py
+recursive-include docs/source *
+include docs/build/empty_file

skeleton/examples/sphinx-package/README_tmpl

@@ -0,0 +1,10 @@
+{project_name} provides {package_name}
+
+{short_description}
+
+TODO
+----
+
+Place the rest of the readme file, in rst format, here.
+
+This is also used on pypi as the long_description

skeleton/examples/sphinx-package/VERSION

@@ -0,0 +1 @@
+0.1.0

skeleton/examples/sphinx-package/docs/Makefile_tmpl

@@ -0,0 +1,95 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  dirhtml   to make HTML files named index.html in directories"
+	@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 "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview of all changed/added/deprecated items"
+	@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."
+
+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/{project_name}.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/{project_name}.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished; the epub files are in $(BUILDDIR)/epub."
+
+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."

skeleton/examples/sphinx-package/docs/make.bat_tmpl

@@ -0,0 +1,114 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+set SPHINXBUILD=sphinx-build
+set BUILDDIR=build
+set SOURCEDIR=source
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% %SOURCEDIR%
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html      to make standalone HTML files
+	echo.  dirhtml   to make HTML files named index.html in directories
+	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.  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  changes   to make an overview over all changed/added/deprecated items
+	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
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "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.
+	goto end
+)
+
+if "%1" == "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\{project_name}.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\{project_name}.ghc
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "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.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end