chore: Reorganized directory structure and cleaned up packaging

falconry · Jan 22, 2013 · 2b91261 · 2b91261
1 parent 04a4598
commit 2b91261
Show file tree

Hide file tree

Showing 49 changed files with 93 additions and 2,264 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -1,4 +1,5 @@
 Falcon is written by various contributors (by date of contribution):
 
 Kurt Griffiths (kgriffs)
+Alejandro Cabrera (cabrera)
 
diff --git a/README.md b/README.md
@@ -19,6 +19,25 @@ Falcon is a *really* fast, light-weight framework for building cloud APIs. It tr
 
 **Cloud-friendly.** Falcon uses the web-friendly Python language, and speaks WSGI, so you can deploy it on your favorite stack. The framework is designed from the ground up to embrace HTTP, not work against it. Plus, diagnostics are built right in to make it easier to track down sneaky bugs and frustrating performance problems. 
 
+
+### Install ###
+
+```bash
+$ pip install falcon
+```
+
+### Test ###
+
+```bash
+$ python setup.py test
+```
+
+To test across all supported Python versions:
+
+```bash
+$ pip install tox && tox
+```
+
 ### Usage ###
 
 More/better docs are on our TODO list, but in the meantime, here is a simple example showing how to create a Falcon-based API.

diff --git a/falcon/bench/nuts/nuts/__init__.py → bench/__init__.py b/falcon/bench/nuts/nuts/__init__.py → bench/__init__.py
diff --git a/falcon/bench/bench.py → bench/bench.py b/falcon/bench/bench.py → bench/bench.py
@@ -6,8 +6,8 @@
 
 from create import *
 
-sys.path.append('../..')
-import falcon.test.helpers as helpers
+sys.path.append('..')
+import tests.helpers as helpers
 del sys.path[-1]
 
 
@@ -16,7 +16,7 @@ def avg(array):
 
 
 def bench(name):
-    iterations = 10000
+    iterations = 100000
 
     func = create_bench(name)
     results = repeat(func, number=iterations)
@@ -63,7 +63,7 @@ def bench():
         ms_per_req = sec_per_req * 1000
         factor = int(baseline / sec_per_req)
 
-        print('{3}. {0:.<15s}{1:.>06,.0f} req/sec or {2:0.2f} ms/req ({4}x)'.
+        print('{3}. {0:.<15s}{1:.>06,.0f} req/sec or {2:0.3f} ms/req ({4}x)'.
               format(name, req_per_sec, ms_per_req, i + 1, factor))
 
     print('')
diff --git a/falcon/bench/create.py → bench/create.py b/falcon/bench/create.py → bench/create.py
@@ -13,7 +13,7 @@
 import app as nuts
 del sys.path[-1]
 
-sys.path.append('../..')
+sys.path.append('..')
 import falcon
 del sys.path[-1]
 

diff --git a/falcon/bench/nuts/MANIFEST.in → bench/nuts/MANIFEST.in b/falcon/bench/nuts/MANIFEST.in → bench/nuts/MANIFEST.in
diff --git a/falcon/bench/nuts/config.py → bench/nuts/config.py b/falcon/bench/nuts/config.py → bench/nuts/config.py
diff --git a/...n/bench/nuts/nuts/controllers/__init__.py → bench/nuts/nuts/__init__.py b/...n/bench/nuts/nuts/controllers/__init__.py → bench/nuts/nuts/__init__.py
diff --git a/falcon/bench/nuts/nuts/app.py → bench/nuts/nuts/app.py b/falcon/bench/nuts/nuts/app.py → bench/nuts/nuts/app.py
diff --git a/bench/nuts/nuts/controllers/__init__.py b/bench/nuts/nuts/controllers/__init__.py
diff --git a/falcon/bench/nuts/nuts/controllers/root.py → bench/nuts/nuts/controllers/root.py b/falcon/bench/nuts/nuts/controllers/root.py → bench/nuts/nuts/controllers/root.py
diff --git a/falcon/bench/nuts/nuts/model/__init__.py → bench/nuts/nuts/model/__init__.py b/falcon/bench/nuts/nuts/model/__init__.py → bench/nuts/nuts/model/__init__.py
diff --git a/falcon/bench/nuts/nuts/templates/error.html → bench/nuts/nuts/templates/error.html b/falcon/bench/nuts/nuts/templates/error.html → bench/nuts/nuts/templates/error.html
diff --git a/falcon/bench/nuts/nuts/templates/index.html → bench/nuts/nuts/templates/index.html b/falcon/bench/nuts/nuts/templates/index.html → bench/nuts/nuts/templates/index.html
diff --git a/falcon/bench/nuts/nuts/templates/layout.html → bench/nuts/nuts/templates/layout.html b/falcon/bench/nuts/nuts/templates/layout.html → bench/nuts/nuts/templates/layout.html
diff --git a/falcon/bench/nuts/nuts/tests/__init__.py → bench/nuts/nuts/tests/__init__.py b/falcon/bench/nuts/nuts/tests/__init__.py → bench/nuts/nuts/tests/__init__.py
diff --git a/falcon/bench/nuts/nuts/tests/config.py → bench/nuts/nuts/tests/config.py b/falcon/bench/nuts/nuts/tests/config.py → bench/nuts/nuts/tests/config.py
diff --git a/.../bench/nuts/nuts/tests/test_functional.py → bench/nuts/nuts/tests/test_functional.py b/.../bench/nuts/nuts/tests/test_functional.py → bench/nuts/nuts/tests/test_functional.py
diff --git a/falcon/bench/nuts/nuts/tests/test_units.py → bench/nuts/nuts/tests/test_units.py b/falcon/bench/nuts/nuts/tests/test_units.py → bench/nuts/nuts/tests/test_units.py
diff --git a/falcon/bench/nuts/public/css/style.css → bench/nuts/public/css/style.css b/falcon/bench/nuts/public/css/style.css → bench/nuts/public/css/style.css
diff --git a/falcon/bench/nuts/public/images/logo.png → bench/nuts/public/images/logo.png b/falcon/bench/nuts/public/images/logo.png → bench/nuts/public/images/logo.png
diff --git a/falcon/bench/nuts/setup.cfg → bench/nuts/setup.cfg b/falcon/bench/nuts/setup.cfg → bench/nuts/setup.cfg
diff --git a/falcon/bench/nuts/setup.py → bench/nuts/setup.py b/falcon/bench/nuts/setup.py → bench/nuts/setup.py
diff --git a/falcon/__init__.py b/falcon/__init__.py
@@ -16,20 +16,9 @@
 
 """
 
-version_tuple = (0, 0, 1, '-dev')
-
-
-def get_version_string():
-    if version_tuple[-1] is not None:
-        return '.'.join(map(str, version_tuple[:-1])) + version_tuple[-1]
-
-    return '.'.join(map(str, version_tuple))
-
-version = get_version_string()
-"""Current version of Falcon."""
-
 # Hoist classes and functions into the falcon namespace
-from .api import API
-from .status_codes import *
-from .exceptions import *
-from .http_error import HTTPError
+from falcon.version import version
+from falcon.api import API
+from falcon.status_codes import *
+from falcon.exceptions import *
+from falcon.http_error import HTTPError
diff --git a/falcon/bench/results.txt b/falcon/bench/results.txt
diff --git a/falcon/exceptions.py b/falcon/exceptions.py
@@ -19,8 +19,8 @@
 
 """
 
-from .http_error import HTTPError
-from .status_codes import *
+from falcon.http_error import HTTPError
+from falcon.status_codes import *
 
 
 class HTTPBadRequest(HTTPError):

diff --git a/falcon/http_error.py b/falcon/http_error.py
@@ -16,10 +16,10 @@
 
 """
 
+import json
 from collections import OrderedDict
 
-from .status_codes import *
-import json
+from falcon.status_codes import *
 
 
 class HTTPError(Exception):

diff --git a/falcon/request.py b/falcon/request.py
@@ -19,8 +19,8 @@
 import sys
 from datetime import datetime
 
-from .request_helpers import *
-from .exceptions import *
+from falcon.request_helpers import *
+from falcon.exceptions import *
 
 
 class Request(object):

diff --git a/falcon/responders.py b/falcon/responders.py
@@ -16,7 +16,7 @@
 
 """
 
-from .status_codes import *
+from falcon.status_codes import *
 
 
 def path_not_found(req, resp):

diff --git a/falcon/version.py b/falcon/version.py
@@ -0,0 +1,22 @@
+"""Falcon version
+
+Copyright 2013 by Rackspace Hosting, Inc.
+
+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.
+
+"""
+
+VERSION_TUPLE = (0, 0, 1, '-dev')
+
+version = '.'.join(map(str, VERSION_TUPLE[:-1])) + VERSION_TUPLE[-1]
+"""Current version of Falcon."""
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,2 @@
+[egg_info]
+tag_build = dev
diff --git a/setup.py b/setup.py
@@ -1,37 +1,38 @@
 from setuptools import setup, find_packages
-import os
 
-import falcon
+import falcon.version
 
-here = os.path.abspath(os.path.dirname(__file__))
-README = open(os.path.join(here, 'README.md')).read()
-NEWS = open(os.path.join(here, 'NEWS.md')).read()
-
-# install_requires = [
-#     'python-statsd>=1.5.7'
-# ]
 
 setup(
     name='falcon',
     version=falcon.version,
-    description="Falcon is a fast micro-framework for building cloud APIs.",
-    long_description=README + '\n\n' + NEWS,
+    description='A fast micro-framework for building cloud APIs.',
+    long_description=None,
     classifiers=[
-        "Development Status :: 2 - Pre-Alpha",
-        "Environment :: Web Environment",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: Apache Software License",
-        "Natural Language :: English",
-        "Topic :: Software Development :: Libraries :: Application Frameworks"
+        'Development Status :: 3 - Alpha',
+        'Environment :: Web Environment',
+        'Natural Language :: English',
+        'Intended Audience :: Developers',
+        'Intended Audience :: System Administrators',
+        'License :: OSI Approved :: Apache Software License',
+        'Operating System :: MacOS :: MacOS X',
+        'Operating System :: Microsoft :: Windows',
+        'Operating System :: POSIX',
+        'Topic :: Internet :: WWW/HTTP :: WSGI',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.7',
+        'Topic :: Software Development :: Libraries :: Application Frameworks'
     ],
-    keywords='wsgi web api framework rest http',
+    keywords='wsgi web api framework rest http cloud',
     author='Kurt Griffiths',
-    author_email='kgriffs@me.com',
+    author_email='mail@kgriffs.com',
     url='https://github.com/racker/falcon',
     license='Apache 2.0',
-    packages=find_packages('falcon'),
-    package_dir={'': 'falcon'},
+    packages=find_packages(exclude=['bench', 'tests']),
     include_package_data=True,
     zip_safe=False,
-    install_requires=[]
+    install_requires=[],
+
+    test_suite='nose.collector',
+    tests_require='nose'
 )
diff --git a/spam b/spam
diff --git a/spam.txt b/spam.txt
diff --git a/falcon/test/__init__.py → tests/__init__.py b/falcon/test/__init__.py → tests/__init__.py
diff --git a/falcon/test/dump_wsgi.py → tests/dump_wsgi.py b/falcon/test/dump_wsgi.py → tests/dump_wsgi.py
diff --git a/falcon/test/helpers.py → tests/helpers.py b/falcon/test/helpers.py → tests/helpers.py
diff --git a/falcon/test/test_example.py → tests/test_example.py b/falcon/test/test_example.py → tests/test_example.py
diff --git a/falcon/test/test_headers.py → tests/test_headers.py b/falcon/test/test_headers.py → tests/test_headers.py
diff --git a/falcon/test/test_hello.py → tests/test_hello.py b/falcon/test/test_hello.py → tests/test_hello.py
diff --git a/falcon/test/test_http_method_routing.py → tests/test_http_method_routing.py b/falcon/test/test_http_method_routing.py → tests/test_http_method_routing.py
diff --git a/falcon/test/test_httperror.py → tests/test_httperror.py b/falcon/test/test_httperror.py → tests/test_httperror.py
diff --git a/falcon/test/test_query_params.py → tests/test_query_params.py b/falcon/test/test_query_params.py → tests/test_query_params.py
diff --git a/falcon/test/test_req_vars.py → tests/test_req_vars.py b/falcon/test/test_req_vars.py → tests/test_req_vars.py
diff --git a/falcon/test/test_request_body.py → tests/test_request_body.py b/falcon/test/test_request_body.py → tests/test_request_body.py
diff --git a/falcon/test/test_uri_templates.py → tests/test_uri_templates.py b/falcon/test/test_uri_templates.py → tests/test_uri_templates.py
diff --git a/falcon/test/test_wsgi.py → tests/test_wsgi.py b/falcon/test/test_wsgi.py → tests/test_wsgi.py
diff --git a/falcon/test/test_wsgi_errors.py → tests/test_wsgi_errors.py b/falcon/test/test_wsgi_errors.py → tests/test_wsgi_errors.py
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,9 @@
+[tox]
+envlist = py27
+
+[testenv]
+deps = nose
+       nose-progressive
+       testtools
+
+commands = nosetests --with-progressive