Browse Source

Update all python readmes, Add readme if missing
Squashed commit of the following:

commit 2638cc1ea529d5f86e4f599149d79091cdd592b2
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 13:33:54 2015 -0700

Update UWSGI readme

commit 08e0a4dbbd028cf85ef72384672b4c022db3be1d
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 13:24:11 2015 -0700

Update wsgi readme

commit becae4c036a4a77027eca151ab68f133d52f22bd
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 11:52:19 2015 -0700

Add more resources to falcon's readme

commit a6c76dda3bc34875962753633b572ad346978fc7
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 11:34:41 2015 -0700

Add links to django readme

commit 57f30a2a94c97891e869d808d25e37786888bef8
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 11:23:23 2015 -0700

Update information in django readme

commit cbd99170a459c00ebb6d42db3490674d6b8335a1
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 11:11:45 2015 -0700

Explain where to find more information in Python API-Hour readme

commit fe549177f31675d1767aa9679a8437caa3e4a2cc
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 11:06:54 2015 -0700

Add API-Hour readme

commit 6dcb9efcf9119f66ff607cf2391499acb853c5f4
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 10:52:16 2015 -0700

Update python bottle readme

commit 90af1bfeb80ce391a9d0e3836967911ab42c8157
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 10:26:08 2015 -0700

Update Tornado readme

commit 2f0c219c985f807f6276d65dddb0c259070920a5
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 10:08:32 2015 -0700

Add information to Pyramid readme

commit 61fe7efed80d7577a5db93528ad433c097a86a06
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 09:36:07 2015 -0700

Add some information to flask readme

commit 13e654799766e7bb87acee5ab3be26e7f2d7add8
Author: Brittany Mazza <[email protected]>
Date: Fri Mar 20 09:07:30 2015 -0700

Update and add some information to Python readme

Brittany Mazza 10 years ago
parent
commit
3f8c96fb76

+ 30 - 0
frameworks/Python/API-Hour/README.md

@@ -0,0 +1,30 @@
+# API-Hour Benchmark Test
+
+This is the API-Hour portion of a [benchmarking tests suite](../../) 
+comparing a variety of web development platforms.
+
+The information below is specific to API-Hour. For further guidance, 
+review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+Also note that there is additional information provided in 
+the [Python README](../).
+
+## Test Paths & Sources
+
+* [JSON Serialization](hello/endpoints/world.py): "/json"
+* [Single Database Query](hello/services/world.py): "/db"
+* [Multiple Database Queries](hello/services/world.py): "/queries?queries=#"*
+* [Fortunes](hello/services/world.py): "/fortunes"
+* [Database Updates](hello/services/world.py): "/updates?queries=#"*
+* [Plaintext](hello/endpoints/world.py): "/plaintext"
+
+*Replace # with an actual number.
+
+## Get Help
+
+### Community
+
+* [API-Hour Google Group](https://groups.google.com/forum/#!forum/api-hour)
+
+### Resources
+
+* [API-Hour Source Code](https://github.com/Eyepea/API-Hour)

+ 21 - 3
frameworks/Python/README.md

@@ -1,9 +1,26 @@
 # Python frameworks
 # Python frameworks
 
 
-## Experts
+The information below contains information specific to Python. 
+For further guidance, review the 
+[documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/).
+
+## Infrastructure Software Versions
+
+* [python2 2.7.9](https://www.python.org/)
+* [python3 3.4.2](https://www.python.org/)
+* [pypy 2.4.0](http://pypy.org/)
+* [nginx 1.4.1](http://nginx.org/)
+
+## Get Help
+
+### Python Experts
 
 
 * INADA Naoki (@methane) -- Expert of Python and Python's MySQL driver.
 * INADA Naoki (@methane) -- Expert of Python and Python's MySQL driver.
 
 
+### [Python Community](https://www.python.org/community/)
+
+* `#python` IRC Channel ([irc.freenode.net](http://freenode.net/))
+* `#python-dev` IRC Channel ([irc.freenode.net](http://freenode.net/))
 
 
 ## Python interpreters
 ## Python interpreters
 
 
@@ -27,7 +44,6 @@ PyPy is the fastest Python implementation with JIT.
 There is PyPy's Python 3 implementation (PyPy3), but it is not so tuned like PyPy2.
 There is PyPy's Python 3 implementation (PyPy3), but it is not so tuned like PyPy2.
 So we don't use it for now.
 So we don't use it for now.
 
 
-
 ## WSGI Servers
 ## WSGI Servers
 
 
 ### Nginx + uWSGI
 ### Nginx + uWSGI
@@ -99,8 +115,10 @@ You can see Flask's files to know how to write new test.
 virtualenv is installed on Python 2 and PyPy.  Use `$IROOT/py3/bin/python3 -m venv $TROOT/py3`
 virtualenv is installed on Python 2 and PyPy.  Use `$IROOT/py3/bin/python3 -m venv $TROOT/py3`
 for Python 3.
 for Python 3.
 
 
+You can set environment variables within `install.sh` or within `setup.sh`.
+
 `bechmark_config` is json file to define test.
 `bechmark_config` is json file to define test.
-See [here](https://github.com/TechEmpower/FrameworkBenchmarks#the-benchmark_configjson-file)
+See [here](http://frameworkbenchmarks.readthedocs.org/en/latest/Codebase/Framework-Files/#benchmark-config-file).
 
 
 `setup_py2.sh` is used to run test on Python 2.  `gunicorn_conf.py` is configuration for gunicorn.
 `setup_py2.sh` is used to run test on Python 2.  `gunicorn_conf.py` is configuration for gunicorn.
 `setup_py2.sh` and `gunicorn_conf.py` are written as generic as possible.
 `setup_py2.sh` and `gunicorn_conf.py` are written as generic as possible.

+ 25 - 21
frameworks/Python/bottle/README.md

@@ -1,34 +1,38 @@
-# Bottle Benchmark Test
+# [Bottle](http://bottlepy.org/docs/dev/index.html) Benchmark Test
 
 
-Single file test, [app.py](app.py)
+This is the Python Bottle portion of a [benchmarking tests suite](../../) 
+comparing a variety of frameworks.
 
 
+The information below is specific to Bottle. For further guidance, 
+review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+Also note that there is additional information that's provided in 
+the [Python README](../).
 
 
-## Test URLs
-### JSON Encoding 
+## Test Paths and Sources
 
 
-http://localhost:8080/json
-
-### Single Row Random Query
+All tests are implemented in a single file ([app.py](app.py)).
 
 
 With ORM:
 With ORM:
-    http://localhost:8080/dbs
-
-Without ORM (raw):
-    http://localhost:8080/dbsraw
-
-### Variable Row Query Test 
 
 
-With ORM:
-    http://localhost:8080/db?queries=2
+* [JSON Serialization](app.py): "/json"
+* [Single Database Query](app.py): "/dbs"
+* [Multiple Database Queries](app.py): "/db?queries=#"*
+* [Fortunes](app.py): "/fortunes"
+* [Database Updates](app.py): "/updates?queries=#"*
+* [Plaintext](app.py): "/plaintext"
 
 
 Without ORM (raw):
 Without ORM (raw):
-    http://localhost:8080/dbraw?queries=2
 
 
-### Fortune Test
+* [Single Database Query](app.py): "/raw-db"
+* [Multiple Database Queries](app.py): "/raw-queries?=#"*
+* [Fortune](app.py): "/raw-fortune"
+* [Database Updates](app.py): "/raw-updates?queries=#"*
 
 
-With ORM:
-    http://localhost:8080/fortune
+*Replace # with an actual number.
 
 
-Without ORM (raw):
-    http://localhost:8080/fortuneraw
+## Get Help
+
+### Community
 
 
+* [bottlepy Google Group](https://groups.google.com/forum/#!forum/bottlepy)
+* `#bottlepy` IRC Channel ([irc.freenode.net](https://freenode.net/))

+ 20 - 20
frameworks/Python/django/README.md

@@ -1,30 +1,30 @@
-# Django Benchmarking Test
+# [Django](https://www.djangoproject.com/) Benchmarking Test
 
 
-This is the Django portion of a benchmarking test suite comparing a variety of web development platforms.
+This is the Django portion of a [benchmarking tests suite](../../) 
+comparing a variety of web development platforms.
 
 
-### JSON Encoding Test
+The information below is specific to Django. For further guidance, 
+review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+Also note that there is additional information provided in 
+the [Python README](../).
 
 
-* [JSON test source](hello/world/views.py)
+## Test Paths & Sources
 
 
+* [JSON Serialization](hello/world/views.py): "/json"
+* [Single Database Query](hello/world/views.py): "/db", [World Model](hello/world/models.py)
+* [Multiple Database Queries](hello/world/views.py): "/dbs?queries=#"*, [World Model](hello/world/models.py)
+* [Fortunes](hello/world/views.py): "/fortunes", [Fortune Model](hello/world/models.py)
+* [Database Updates](hello/world/views.py): "/update?queries=#"*, [World Model](hello/world/models.py)
+* _Plaintext: N/A_
 
 
-### Data-Store/Database Mapping Test
+*Replace # with an actual number.
 
 
-* [DB test controller](hello/world/views.py)
-* [DB test model](hello/world/models.py)
+## Get Help
 
 
+### [Community](https://www.djangoproject.com/community/)
 
 
-## Resources
-* https://docs.djangoproject.com/en/dev/intro/tutorial01/
+* `#django` IRC Channel ([irc.freenode.net](https://freenode.net/))
 
 
-## Test URLs
-### JSON Encoding Test
+### Resources
 
 
-http://localhost:8080/json
-
-### Data-Store/Database Mapping Test
-
-http://localhost:8080/db
-
-### Variable Query Test
-
-http://localhost:8080/db?queries=2
+* [Writing your first Django app](https://docs.djangoproject.com/en/dev/intro/tutorial01/)

+ 27 - 9
frameworks/Python/falcon/README.md

@@ -1,25 +1,43 @@
 # Falcon Benchmark Test (ported from Flask example)
 # Falcon Benchmark Test (ported from Flask example)
 
 
-Single file test, [app.py](app.py)
+This is the Falcon portion of a [benchmarking tests suite](../../) 
+comparing a variety of web development platforms.
+
+The information below is specific to Falcon. For further guidance, 
+review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+Also note that there is additional information provided in 
+the [Python README](../).
 
 
 ## Description
 ## Description
 
 
 Falcon API framework (http://falconframework.org)
 Falcon API framework (http://falconframework.org)
 
 
-### Database
-
-(none at the moment)
+## Infrastructure Software
 
 
 ### Server
 ### Server
 
 
 * gunicorn+meinheld on CPython
 * gunicorn+meinheld on CPython
 * Tornado on PyPy
 * Tornado on PyPy
 
 
-## Test URLs
-### JSON Encoding
+## Test Paths & Sources
+
+All of the test implementations are located within a single file ([app.py](app.py)).
+
+* [JSON Serialization](app.py): "/json"
+* _Single Database Query: N/A_
+* _Multiple Database Queries: N/A_
+* _Fortunes: N/A_
+* _Database Updates: N/A_
+* [Plaintext](app.py): "/plaintext"
+
+## Get Help
+
+### Resources
 
 
-http://localhost:8080/json
+* [Falcon Source Code](https://github.com/falconry/falcon)
 
 
-### Plaintext
+### [Community](http://falcon.readthedocs.org/en/0.2.0/community/index.html)
 
 
-http://localhost:8080/plaintext
+* `#falconframework` IRC Channel ([irc.freenode.net](https://freenode.net/))
+* Subscribe to email list by emailing falcon[at]librelist.com and 
+following the instructions in the reply.

+ 11 - 3
frameworks/Python/flask/README.md

@@ -1,6 +1,15 @@
-# Flask Benchmark Test
+# [Flask](http://flask.pocoo.org/) Benchmark Test
 
 
-Single file test, [app.py](app.py)
+The information below is specific to Flask. For further guidance, 
+review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+Also note that there is additional information that's provided in 
+the [Python README](../).
+
+This is the Python Flask portion of a [benchmarking tests suite](../../) 
+comparing a variety of frameworks.
+
+All test implementations are located within a single file 
+([app.py](app.py)).
 
 
 ## Description
 ## Description
 
 
@@ -20,7 +29,6 @@ MySQL (MySQL-python on CPython, PyMySQL on PyPy)
 * gunicorn+meinheld on CPython
 * gunicorn+meinheld on CPython
 * Tornado on PyPy
 * Tornado on PyPy
 
 
-
 ## Test URLs
 ## Test URLs
 ### JSON Encoding 
 ### JSON Encoding 
 
 

+ 20 - 19
frameworks/Python/pyramid/README.md

@@ -1,31 +1,32 @@
 # Pyramid benchmark test
 # Pyramid benchmark test
 
 
+This is the Python Pyramid portion of a [benchmarking tests suite](../../) 
+comparing a variety of frameworks.
+
+The information below is specific to Pyramid. For further guidance, 
+review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+Also note that there is additional information that's provided in 
+the [Python README](../).
+
 [Pyramid](http://www.pylonsproject.org/) is a flexible Python 2/3 framework.
 [Pyramid](http://www.pylonsproject.org/) is a flexible Python 2/3 framework.
 This test uses [SQLAlchemy](http://www.sqlalchemy.org/) as its ORM, the default
 This test uses [SQLAlchemy](http://www.sqlalchemy.org/) as its ORM, the default
 [Chameleon](http://www.pylonsproject.org/) for its templating, and
 [Chameleon](http://www.pylonsproject.org/) for its templating, and
 [Gunicorn](https://github.com/benoitc/gunicorn) for the application server.
 [Gunicorn](https://github.com/benoitc/gunicorn) for the application server.
 
 
-## Test URLs
-
-### JSON Encoding
-
-http://localhost:6543/json
-
-### Single Row Random Query
-
-http://localhost:6543/db
-
-### Variable Row Query Test
-
-http://localhost:6543/queries?queries=10
+## Test Paths & Source
 
 
-### Fortune Test
+* [JSON Serialization](frameworkbenchmarks/tests.py): "/json"
+* [Single Database Query](frameworkbenchmarks/tests.py): "/db", [World Model](frameworkbenchmarks/models.py)
+* [Multiple Database Queries](frameworkbenchmarks/tests.py): "queries?queries=#"*, [World Model](frameworkbenchmarks/models.py)
+* [Fortunes](frameworkbenchmarks/tests.py): "/fortunes", [Fortune Model](frameworkbenchmarks/models.py)
+* [Database Updates](frameworkbenchmarks/tests.py): "updates?queries=#"*, [World Model](frameworkbenchmarks/models.py)
+* [Plaintext](frameworkbenchmarks/tests.py): "/plaintext"
 
 
-http://localhost:6543/fortunes
+*Replace # with an actual number.
 
 
-### Updates
-http://localhost:6543/updates?queries=10
+## Get Help
 
 
-### Plaintext
+### Community
 
 
-http://localhost:6543/plaintext
+* `#pyramid` IRC Channel ([irc.freenode.net](https://freenode.net/))
+* [Pyramid (pylons-discuss) Google Group](https://groups.google.com/forum/#!forum/pylons-discuss)

+ 29 - 11
frameworks/Python/tornado/README.md

@@ -1,16 +1,12 @@
 # Tornado Benchmarking Test
 # Tornado Benchmarking Test
 
 
-This is the Tornado portion of a benchmarking test suite comparing a variety of web development platforms.
-
-### JSON Encoding Test
-
-* [JSON test source](server.py)
-
-
-### Data-Store/Database Mapping Test
-
-* [Database teste source Raw](server.py)
+This is the Tornado portion of a [benchmarking tests suite](../../) 
+comparing a variety of web development platforms.
 
 
+The information below is specific to Tornado. For further guidance, 
+review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+Also note that there is additional information that's provided in 
+the [Python README](../).
 
 
 ## Infrastructure Software
 ## Infrastructure Software
 
 
@@ -19,6 +15,28 @@ This is the Tornado portion of a benchmarking test suite comparing a variety of
 * [Mongodb](https://www.mongodb.org/) with [motor](http://motor.readthedocs.org/en/stable/)
 * [Mongodb](https://www.mongodb.org/) with [motor](http://motor.readthedocs.org/en/stable/)
 * [PostgreSQL](http://www.postgresql.org/) with [momoko](http://momoko.61924.nl/en/latest/)
 * [PostgreSQL](http://www.postgresql.org/) with [momoko](http://momoko.61924.nl/en/latest/)
 
 
+## Test Paths & Sources
+
+### Raw Database Tests
+
+* [Single Database Query](server.py): "/dbraw"
+* [Multiple Database Queries](server.py): "/queriesraw?queries=#"*
+
+### Tests
+
+* [JSON Serialization](server.py): "/json"
+* [Single Database Query](server.py): "/db"
+* [Multiple Database Queries](server.py): "/queries?queries=#"*
+* [Plaintext](server.py): "/plaintext"
+
+*Replace # with an actual number.
+
+## Get Help
+
+### Community
+
+* [python-tornado Google Group](https://groups.google.com/forum/#!forum/python-tornado)
+
+### Resources
 
 
-## Resources
 * http://www.tornadoweb.org/en/stable/documentation.html
 * http://www.tornadoweb.org/en/stable/documentation.html

+ 29 - 0
frameworks/Python/uwsgi/README.md

@@ -0,0 +1,29 @@
+# UWSGI Benchmarking Test
+
+This is the UWSGI portion of a [benchmarking tests suite](../../) 
+comparing a variety of web development platforms.
+
+The information below is specific to UWSGI. For further guidance, 
+review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+Also note that there is additional information provided in 
+the [Python README](../).
+
+## Test Paths & Sources
+
+* [JSON Serialization](hello.py): "/json"
+* _Single Database Query: N/A_
+* _Multiple Database Queries: N/A_
+* _Fortunes: N/A_
+* _Database Updates: N/A_
+* _Plaintext: N/A_
+
+## Get Help
+
+### Community
+
+* `#uwsgi` IRC Channel ([irc.freenode.net](https://freenode.net/))
+
+### References
+
+* [UWSGI Source Code](https://github.com/unbit/uwsgi)
+* [UWSGI Docs](https://uwsgi-docs.readthedocs.org/en/latest/)

+ 20 - 10
frameworks/Python/wsgi/README.md

@@ -1,22 +1,32 @@
 # WSGI Benchmarking Test
 # WSGI Benchmarking Test
 
 
-This is the WSGI portion of a [benchmarking test suite](../) comparing a variety of web development platforms.
+This is the WSGI portion of a [benchmarking tests suite](../../) 
+comparing a variety of web development platforms.
 
 
-### JSON Encoding Test
-
-
-* [JSON test controller/view](hello.py)
+The information below is specific to WSGI. For further guidance, 
+review the [documentation](http://frameworkbenchmarks.readthedocs.org/en/latest/). 
+Also note that there is additional information provided in 
+the [Python README](../).
 
 
 ## Infrastructure Software Versions
 ## Infrastructure Software Versions
+
 The tests were run with:
 The tests were run with:
+
 * [Python 2.7.3](http://www.python.org/)
 * [Python 2.7.3](http://www.python.org/)
 * [Gunicorn 0.17.2](http://gunicorn.org/)
 * [Gunicorn 0.17.2](http://gunicorn.org/)
 
 
+## Test Paths & Sources
+
+* [JSON Serialization](hello.py): "/json"
+* Single Database Query: N/A_
+* Multiple Database Queries: N/A_
+* Fortunes: N/A_
+* Database Updates: N/A_
+* [Plaintext](hello.py): "/plaintext"
 
 
-## References
-http://docs.gunicorn.org/en/latest/run.html
+## Get Help
 
 
-## Test URLs
-### JSON Encoding Test
+### References
 
 
-http://localhost:8080/json
+* [WSGI Docs](http://wsgi.readthedocs.org/en/latest/)
+* [Gunicorn Docs](http://docs.gunicorn.org/en/latest/run.html)