summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Bangert <ben@groovie.org>2012-03-13 11:09:25 -0700
committerBen Bangert <ben@groovie.org>2012-03-13 11:09:25 -0700
commit59d0ec306e2e09d2a2a36c8431ebf9d7517c1931 (patch)
treec268a77f5343be1ac4e506411fe1774377e34336
parent171ecf1168cee5c28cb062d60f2230e6b7c44e19 (diff)
downloadroutes-59d0ec306e2e09d2a2a36c8431ebf9d7517c1931.tar.gz
Various cleanups and such for RTD and travis
--HG-- branch : trunk rename : CHANGELOG => CHANGELOG.rst rename : LICENSE => LICENSE.txt rename : README => README.rst
-rw-r--r--CHANGELOG.rst (renamed from CHANGELOG)0
-rw-r--r--LICENSE27
-rw-r--r--LICENSE.txt19
-rw-r--r--README.rst (renamed from README)0
-rw-r--r--docs/_templates/index.html70
-rw-r--r--docs/_templates/indexsidebar.html19
-rw-r--r--docs/_templates/layout.html11
-rw-r--r--docs/changes.rst2
-rw-r--r--docs/conf.py2
-rw-r--r--docs/contents.rst6
-rw-r--r--setup.py42
11 files changed, 49 insertions, 149 deletions
diff --git a/CHANGELOG b/CHANGELOG.rst
index 4c3bb5e..4c3bb5e 100644
--- a/CHANGELOG
+++ b/CHANGELOG.rst
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index f15e9f9..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,27 +0,0 @@
-Copyright (c) 2005-2008 Ben Bangert <ben@groovie.org>
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
-2. 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.
-3. The name of the author or contributors may not be used to endorse or
- promote products derived from this software without specific prior
- written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..fb5a38f
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,19 @@
+Copyright (c) 2005-2012 Ben Bangert <ben@groovie.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README b/README.rst
index 5966ba0..5966ba0 100644
--- a/README
+++ b/README.rst
diff --git a/docs/_templates/index.html b/docs/_templates/index.html
deleted file mode 100644
index 01ce011..0000000
--- a/docs/_templates/index.html
+++ /dev/null
@@ -1,70 +0,0 @@
-{% extends "layout.html" %}
-{% set title = 'Overview' %}
-{% block body %}
-<img src="_images/routes-logo.png" width="100" height="171"
-style="float:left;margin:1em" />
-
- <p>Routes is a Python re-implementation of the Rails routes system for
- mapping URLs to application actions, and conversely to generate URLs. Routes
- makes it easy to create pretty and concise URLs that are RESTful with little
- effort.</p>
-
- <p>Routes allows conditional matching based on domain, cookies, HTTP method,
- or a custom function. Sub-domain support is built in. Routes comes with an
- extensive unit test suite.</p>
-
- <p>Buzzword Compliance: <em>REST</em>, <em>DRY</em></p>
-
-<h2 style="clear: both;">New features</h2>
-
-<div style="font-size:smaller">
-
-<p>Version 1.12 (2010-02-28)</p>
-
-<ul>
- <li>Explicit method of calling Mapper.routematch directly</li>
- <li>Submapper improvements for better resource handling</li>
- <li>Various bug fixes</li>
-</ul>
-
-<p>Version 1.11 (2009-09-28)</p>
-
-<ul>
- <li>Completely new manual</li>
- <li>Add a group of routes under a common URL prefix</li>
-</ul>
-
-
-</div>
-
-<p><a href="changes.html">Full changelog</a></p>
-
-
- <h2>Documentation</h2>
- <table class="contentstable" align="center" style="margin-left: 30px"><tr>
- <td width="50%">
- <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Contents</a><br/>
- <span class="linkdescr">for a complete overview</span></p>
- <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search</a><br/>
- <span class="linkdescr">search the documentation</span></p>
- <p class="biglink"><a class="biglink" href="{{ pathto("todo") }}">TODO</a><br/>
- <span class="linkdescr">future development plans</span></p>
- </td><td width="50%">
- <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br/>
- <span class="linkdescr">all functions, classes, terms</span></p>
- <p class="biglink"><a class="biglink" href="{{ pathto("modindex") }}">Module Index</a><br/>
- <span class="linkdescr">quick access to all documented modules</span></p>
- </td></tr>
- </table>
-
- <p>Download <a href="http://routes.groovie.org/routes.pdf">Routes PDF documentation</a>.</p>
-
- <h2>Developers / Source Code</h2>
- <p>Routes' Mercurial repository can be found at
- <a href="http://bitbucket.org/bbangert/routes/"><tt>http://bitbucket.org/bbangert/routes/</tt></a>.</p>
-
- <p>To check it out:</p>
-
- <pre>hg clone http://www.bitbucket.org/bbangert/routes</pre>
-
-{% endblock %}
diff --git a/docs/_templates/indexsidebar.html b/docs/_templates/indexsidebar.html
deleted file mode 100644
index b7a557d..0000000
--- a/docs/_templates/indexsidebar.html
+++ /dev/null
@@ -1,19 +0,0 @@
-{% if version.endswith('(hg)') %}
-<h3>Download Routes</h3>
-<p>This documentation is for version <b>{{ version }}</b>, which is
- not released yet.</p>
-<p>You can use it from the
- <a href="http://bitbucket.org/bbangert/routes/">Mercurial repo</a> or look for
- released versions in the <a href="http://pypi.python.org/pypi/Routes">Python
- Package Index</a>.</p>
-{% else %}
-<h3>Download Routes {{ version }}</h3>
-<p>Get Routes from the <a href="http://pypi.python.org/pypi/Routes">Python Package
-Index</a>, or install it with:</p>
-<pre>easy_install -U Routes</pre>
-{% endif %}
-
-<h3>Bugs? Suggestions?</h3>
-
-<p>Report them at the Bitbucket
- <a href="http://www.bitbucket.org/bbangert/routes/issues/">tracker</a>.</p>
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
deleted file mode 100644
index 2b0e9e2..0000000
--- a/docs/_templates/layout.html
+++ /dev/null
@@ -1,11 +0,0 @@
-{% extends "!layout.html" %}
-
-{% block rootrellink %}
- <li><a href="{{ pathto('index') }}">Routes home</a>&nbsp;|&nbsp;</li>
- <li><a href="{{ pathto('contents') }}">Documentation</a>&raquo;</li>
-{% endblock %}
-
-{% block header %}
-<div style="color: #D1361B; font-size: 70px; font-weight: bold; padding: 10px 0 0 10px;">Routes</div>
-</div>
-{% endblock %} \ No newline at end of file
diff --git a/docs/changes.rst b/docs/changes.rst
index 729d137..dedd787 100644
--- a/docs/changes.rst
+++ b/docs/changes.rst
@@ -2,4 +2,4 @@
.. _changes:
-.. include:: ../CHANGELOG
+.. include:: ../CHANGELOG.rst
diff --git a/docs/conf.py b/docs/conf.py
index 528a751..bf7c4df 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -133,7 +133,7 @@ html_theme_options = {
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
-html_use_opensearch = 'http://routes.groovie.org/'
+# html_use_opensearch = 'http://routes.groovie.org/'
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
diff --git a/docs/contents.rst b/docs/contents.rst
index fdb999a..4b4d876 100644
--- a/docs/contents.rst
+++ b/docs/contents.rst
@@ -1,6 +1,11 @@
Routes Documentation
====================
+Routes is a Python re-implementation of the Rails routes system for mapping URLs to application actions, and conversely to generate URLs. Routes makes it easy to create pretty and concise URLs that are RESTful with little effort.
+
+Routes allows conditional matching based on domain, cookies, HTTP method, or a custom function. Sub-domain support is built in. Routes comes with an extensive unit test suite.
+
+
.. toctree::
:maxdepth: 2
@@ -22,7 +27,6 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
-* :ref:`search`
* :ref:`glossary`
Module Listing
diff --git a/setup.py b/setup.py
index 197485e..dab4f94 100644
--- a/setup.py
+++ b/setup.py
@@ -1,20 +1,18 @@
-try:
- from setuptools import setup, find_packages
-except ImportError:
- from ez_setup import use_setuptools
- use_setuptools()
- from setuptools import setup, find_packages
+__version__ = '1.13'
+
+import os
+
+from setuptools import setup, find_packages
+
+here = os.path.abspath(os.path.dirname(__file__))
+README = open(os.path.join(here, 'README.rst')).read()
+CHANGES = open(os.path.join(here, 'CHANGELOG.rst')).read()
-version = '1.13'
setup(name="Routes",
- version=version,
+ version=__version__,
description='Routing Recognition and Generation Tools',
- long_description="""
-A Routing package for Python that matches URL's to dicts and vice versa
-
-`Dev version available <http://bitbucket.org/bbangert/routes/>`_
-""",
+ long_description=README + '\n\n' +CHANGES,
classifiers=["Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
@@ -22,12 +20,18 @@ A Routing package for Python that matches URL's to dicts and vice versa
"Topic :: Internet :: WWW/HTTP",
"Topic :: Software Development :: Libraries :: Python Modules",
],
- author='Ben Bangert',
- install_requires=['repoze.lru>=0.3'],
- author_email='ben@groovie.org',
+ keywords='routes webob dispatch',
+ author="Ben Bangert",
+ author_email="ben@groovie.org",
url='http://routes.groovie.org/',
+ license="MIT",
+ packages=find_packages(),
+ test_suite="nose.collector",
+ include_package_data=True,
zip_safe=False,
- test_suite='nose.collector',
- tests_require=['nose', 'webtest', 'paste'],
+ tests_require=['nose', 'webtest', 'webob', 'coverage'],
+ install_requires=[
+ "repoze.lru>=0.3"
+ ],
packages=find_packages(exclude=['tests', 'ez_setup']),
- )
+)