changeset 27:a983d9bb7003

README: streamlining
author Jeff Hammel <k0scist@gmail.com>
date Wed, 12 Apr 2017 13:36:34 -0700
parents 9374bb82258e
children b3a950065844
files README.txt
diffstat 1 files changed, 11 insertions(+), 122 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Wed Apr 12 11:42:15 2017 -0700
+++ b/README.txt	Wed Apr 12 13:36:34 2017 -0700
@@ -8,9 +8,8 @@
 wsgintegrate core
 -----------------
 
-- pyloader: utilities for loading and calling python objects
-  : url: http://k0s.org/hg/pyloader
-  : provides: python loader
+``wsgintegrate`` is dependends on pyloader for loading and
+calling python objects: http://k0s.org/hg/pyloader
 
 - wgintegrate: wsgintegrate provides an integration layer to support
   general-purpose WSGI pipes
@@ -19,13 +18,13 @@
   : requires: pyloader, paste
   : type: app
 
-- paste: WSGI server and utilities
-  : url: http://pythonpaste.org
-  : provides: fileserver, server
+Also worth mentioning is ``paste`` (WSGI server and utilities).  Much of
+how wsgintegrate is shaped is based on ``paste``'s utilities and structure:
+http://pythonpaste.org
 
 
-site management and deployment
-------------------------------
+Examples: site management and deployment
+----------------------------------------
 
 - buttercup: the flower containing the deployment pattern for k0s.org;
   currently, there is only one flower, but it will eventually be
@@ -44,12 +43,9 @@
   : requires: unison
   : type: utility
 
-- wsgiblob: a precursor of wsgintegrate and pyloader
-  : url: http://k0s.org/hg/wsgiblob/
 
-
-WSGI Endpoint Apps
-------------------
+EXamples:  WSGI Endpoint Apps
+-----------------------------
 
 - bitsyblog: blogging app
   : url: http://k0s.org/hg/bitsyblog/
@@ -72,11 +68,6 @@
   : requires: decoupage
   : type: plugin
 
-- SimpleWiki: a basic wiki
-  : url: http://k0s.org/hg/SimpleWiki/
-  : provides: wiki
-  : type: app, unfinished
-
 - toolbox: content categorizer
   : url: http://github.com/mozilla/toolbox
   : provides: classification
@@ -99,8 +90,8 @@
   : type: app
 
 
-WSGI Middleware apps
---------------------
+WSGI Middleware
+---------------
 
 - Commentator: comment on mostly arbitrary URLs
   : url: http://k0s.org/hg/commentator/
@@ -120,105 +111,3 @@
   : provides: tagging
   : requires: lxmlmiddleware
   : type: app, middleware, unfinished
-
-
-Utilities
----------
-
-- bitsyapps: do various things with your bitysblog post
-  : url: http://k0s.org/hg/bitsyapps/
-  : provides: write to file
-  : requires: bitsyblog
-  : type: plugin, unfinished
-
-- bitsyauth: simple authentication middleware
-  : url: http://k0s.org/hg/bitsyauth/
-  : type: auth, middleware
-
-- bitsytweet: tweet your bitsyblog posts; currently broken: see
-  http://k0s.org/blog/20101125140133
-  : url: http://k0s.org/hg/bitsytweet/
-  : provides: tweets
-  : requires: bitsyblog
-  : type: plugin, broken
-
-- CAPTCHA Middleware: provide a CAPTCHA-based authentication token
-  with middleware
-  : url: http://k0s.org/hg/CAPTCHAmiddleware/
-  : provides: auth
-  : type: middleware, unfinished
-
-- contenttransformer: dynamically transform content from one type to
-  another
-  : url: http://k0s.org/hg/contenttransformer/
-  : provides: content transformation
-  : type: middleware
-
-- cropresize: transform an image size appropriate for web content
-  : url: http://k0s.org/hg/cropresize/
-  : requires: image
-  : type: utility
-
-- hgpaste: serve mercurial repositories as WSGI apps
-  : provides: version control
-  : requires: paste, hg
-  : type: app, factory
-
-- lxmlmiddleware: decompose an XML/HTML response into via lxml for processing
-  : url: http://k0s.org/hg/lxmlmiddleware/
-  : provides: response decomposition
-  : requires: lxml
-  : type: middleware
-
-- redirectall: redirect all traffic as moved permanantly
-  : url: http://k0s.org/hg/redirectall
-  : provides: redirection
-  : requires: paste
-  : type: utility
-
-- redirector: WSGI middleware for handling redirection
-  : url: http://k0s.org/hg/redirector/
-  : provides: redirection
-  : type: middleware, utility
-
-- relocator: fill out location headers on the way out given a base url
-  : url: http://k0s.org/hg/relocator/
-  : provides: redirection
-  : type: middleware, utility
-
-- theslasher: remove trailing slashes from requests via redirection
-  : url: http://k0s.org/hg/theslasher/
-  : provides: redirection
-  : type: middleware, utility
-
-- webob: WSGI request/response objects
-  : url: http://pythonpaste.org/webob
-  : provides: request, response
-
-
-Templates
----------
-
-Either template engines or templates that use them
-
-- genshi: template rendering engine
-  : url: http://genshi.edgewall.com
-  : provides: templates
-  : type: template language
-
-- genshi view: a simple webob view with genshi + tempita templates
-  : url: http://k0s.org/hg/genshi_view/
-  : provides: app, middleware, jquery
-  : requires: webob, genshi, tempita
-  : type: template
-
-- tempita: simple template engine
-  : url: http://pypi.python.org/pypi/tempita
-  : provides: templates
-  : type: template language
-
-- webob view: a simple webob view
-  : url: http://k0s.org/hg/webob_view/
-  : provides: app, middleware
-  : requires: webob
-  : type: template