Changeset 184

Show
Ignore:
Timestamp:
08/16/08 21:31:00 (3 months ago)
Author:
rgrp
Message:

[tags/shakespeare-0.5][xs]: correct version to 0.5 from 0.5dev and correct CHANGELOG.txt.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • tags/shakespeare-0.5/CHANGELOG.txt

    Revision 153 Revision 184
    1v0.5: 2008-05-10 1v0.5: 2008-06-01 
    2================ 2================ 
    3 3 
    4  * Move to Pylons and rework web interface 4  * Move to Pylons and rework web interface 
    5  * Move command line interface to use pastescript 5  * Move command line interface to use pastescript 
    6  * Now have Milton in addition to Shakespeare 6  * Now have Milton in addition to Shakespeare 
    7  * Store copies of texts in package (shksprdata) rather than downloading. 7  * Store copies of texts in package (shksprdata) rather than downloading. 
      8  * Refactor site layout and move to 'KForge/CKAN' look. 
    8 9 
    9v0.4: 2007-04-16 10v0.4: 2007-04-16 
    10================ 11================ 
    11 12 
    12  * Annotation of texts (js-based in browser) (ticket:20, ticket:21) 13  * Annotation of texts (js-based in browser) (ticket:20, ticket:21) 
    13    (<http://www.openshakespeare.org/2007/04/10/annotation-is-working/>) 14    (<http://www.openshakespeare.org/2007/04/10/annotation-is-working/>) 
    14  * Switch to unicode for internal string handling (resolves ticket:23: some 15  * Switch to unicode for internal string handling (resolves ticket:23: some 
    15    texts breaking the viewer) 16    texts breaking the viewer) 
    16  * Add functional tests for the web interface (ticket:11) 17  * Add functional tests for the web interface (ticket:11) 
    17  * Substantial improvements to speed of concordance (ticket:22) 18  * Substantial improvements to speed of concordance (ticket:22) 
    18    (<http://www.openshakespeare.org/2007/01/03/improvements-to-the-concordance/>) 19    (<http://www.openshakespeare.org/2007/01/03/improvements-to-the-concordance/>) 
    19  * Switch to genshi templates from kid 20  * Switch to genshi templates from kid 
    20  * Switch to plain WSGI from cherrypy 21  * Switch to plain WSGI from cherrypy 
    21 22 
    22Outstanding Issues 23Outstanding Issues 
    23------------------ 24------------------ 
    24 25 
    25  * Annotation cannot handle long texts because of javascript performance 26  * Annotation cannot handle long texts because of javascript performance 
    26    issues 27    issues 
    27 28 
    28 29 
    29v0.3: 2006-10-04 30v0.3: 2006-10-04 
    30================ 31================ 
    31 32 
    32  * Can now view mutiple texts side by side (ticket:15). See it in action at: 33  * Can now view mutiple texts side by side (ticket:15). See it in action at: 
    33    <http://demo.openshakespeare.org/view?name=othello_gut_f+othello_gut> 34    <http://demo.openshakespeare.org/view?name=othello_gut_f+othello_gut> 
    34  * Now include moby/bosak versions of shakespeare as well as gutenberg 35  * Now include moby/bosak versions of shakespeare as well as gutenberg 
    35    (ticket:10) (though more work remains to be done to process these versions 36    (ticket:10) (though more work remains to be done to process these versions 
    36    to plaintext and html) 37    to plaintext and html) 
    37  * Fix bug whereby we were missing some of the available gutenberg texts  38  * Fix bug whereby we were missing some of the available gutenberg texts  
    38    (ticket:18) 39    (ticket:18) 
    39  * Install the shakespeare python package (ticket:16) 40  * Install the shakespeare python package (ticket:16) 
    40  * Move to py.test from unittest 41  * Move to py.test from unittest 
    41  * New project website at <http://www.openshakespeare.org/> 42  * New project website at <http://www.openshakespeare.org/> 
    42 43 
    43Outstanding Issues 44Outstanding Issues 
    44------------------ 45------------------ 
    45 46 
    46  * Several of the source texts (all of them Gutenberg folios) seem to  47  * Several of the source texts (all of them Gutenberg folios) seem to  
    47    break the viewer due to kid (the templating system) complaining about about 48    break the viewer due to kid (the templating system) complaining about about 
    48    'not well-formed (invalid token) xml'. Any help in tracking this down would 49    'not well-formed (invalid token) xml'. Any help in tracking this down would 
    49    be greatly appreciated. 50    be greatly appreciated. 
    50 51 
    51 52 
    52v0.2 2006-07-16 53v0.2 2006-07-16 
    53=============== 54=============== 
    54 55 
    55  * Database backend with proper domain model (ticket:6) 56  * Database backend with proper domain model (ticket:6) 
    56  * Text snippets in concordance system and links through to source (ticket:12) 57  * Text snippets in concordance system and links through to source (ticket:12) 
    57  * Sources document (ticket:5) 58  * Sources document (ticket:5) 

  • tags/shakespeare-0.5/shakespeare/__init__.py

    Revision 155 Revision 184
    1''' 1''' 
    2Introduction 2Introduction 
    3************ 3************ 
    4 4 
    5The Open Shakespeare package provides a full open set of shakespeare's works 5The Open Shakespeare package provides a full open set of shakespeare's works 
    6(often in multiple versions) along with ancillary material, a variety of tools 6(often in multiple versions) along with ancillary material, a variety of tools 
    7and a python API. 7and a python API. 
    8 8 
    9Specifically in addition to the works themselves (often in multiple versions) 9Specifically in addition to the works themselves (often in multiple versions) 
    10there is an introduction, a chronology, explanatory notes, a concordance and 10there is an introduction, a chronology, explanatory notes, a concordance and 
    11search facilities. 11search facilities. 
    12 12 
    13All material is open source/open knowledge so that anyone can use, redistribute 13All material is open source/open knowledge so that anyone can use, redistribute 
    14and reuse these materials freely. For exact details of the license under which 14and reuse these materials freely. For exact details of the license under which 
    15this package is made available please see COPYING.txt. 15this package is made available please see COPYING.txt. 
    16 16 
    17Open Shakespeare has been developed under the aegis of the Open Knowledge 17Open Shakespeare has been developed under the aegis of the Open Knowledge 
    18Foundation (http://www.okfn.org/). 18Foundation (http://www.okfn.org/). 
    19 19 
    20Contact the Project 20Contact the Project 
    21******************* 21******************* 
    22 22 
    23Please mail info@okfn.org or join the okfn-discuss mailing list: 23Please mail info@okfn.org or join the okfn-discuss mailing list: 
    24 24 
    25  http://lists.okfn.org/listinfo/okfn-discuss 25  http://lists.okfn.org/listinfo/okfn-discuss 
    26 26 
    27 27 
    28Installation and Setup 28Installation and Setup 
    29********************** 29********************** 
    30 30 
    311. Install the code 311. Install the code 
    32=================== 32=================== 
    33 33 
    341.1: (EITHER) Install using setup.py (preferred) 341.1: (EITHER) Install using setup.py (preferred) 
    35------------------------------------------------ 35------------------------------------------------ 
    36 36 
    37Install ``shakespeare`` using easy_install:: 37Install ``shakespeare`` using easy_install:: 
    38 38 
    39    easy_install shakespeare 39    easy_install shakespeare 
    40 40 
    41NB: If you don't have easy_install you can get from here: 41NB: If you don't have easy_install you can get from here: 
    42 42 
    43<http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions> 43<http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions> 
    44 44 
    45 45 
    461.2 (OR) Get the code straight from subversion 461.2 (OR) Get the code straight from subversion 
    47------------------------------------------------ 47------------------------------------------------ 
    48 48 
    491. Check out the subversion trunk:: 491. Check out the subversion trunk:: 
    50 50 
    51    svn co https://knowledgeforge.net/shakespeare/svn/trunk 51    svn co https://knowledgeforge.net/shakespeare/svn/trunk 
    52 52 
    532. Do:: 532. Do:: 
    54 54 
    55    sudo python setup.py develop 55    sudo python setup.py develop 
    56 56 
    57 57 
    582. Setup Package 582. Setup Package 
    59================ 59================ 
    60 60 
    61Make a config file as follows:: 61Make a config file as follows:: 
    62 62 
    63    paster make-config shakespeare config.ini 63    paster make-config shakespeare config.ini 
    64 64 
    65Tweak the config file as appropriate and then setup the application:: 65Tweak the config file as appropriate and then setup the application:: 
    66 66 
    67    paster setup-app config.ini 67    paster setup-app config.ini 
    68 68 
    69 69 
    703. Initialize the system 703. Initialize the system 
    71======================== 71======================== 
    72 72 
    73Run:: 73Run:: 
    74 74 
    75    $ shakespeare-admin db create 75    $ shakespeare-admin db create 
    76    $ shakespeare-admin db init 76    $ shakespeare-admin db init 
    77 77 
    78If you want to build the concordance do:: 78If you want to build the concordance do:: 
    79 79 
    80    $ shakespeare-admin concordance 80    $ shakespeare-admin concordance 
    81 81 
    82NB: This may take some time to run so be patient. TIP: using sqlite building 82NB: This may take some time to run so be patient. TIP: using sqlite building 
    83the concordance really **does** seem to run forever so recommend using 83the concordance really **does** seem to run forever so recommend using 
    84postgresql or mysql if you are going to build the concordance.  84postgresql or mysql if you are going to build the concordance.  
    85 85 
    86 86 
    87Getting Started 87Getting Started 
    88*************** 88*************** 
    89 89 
    90As a user: 90As a user: 
    91========== 91========== 
    92 92 
    93Start up the web interface by running the webserver:: 93Start up the web interface by running the webserver:: 
    94 94 
    95    $ paster serve {your-config.ini} 95    $ paster serve {your-config.ini} 
    96 96 
    97NB: {your-config.ini} should be replaced with the name of the config file you 97NB: {your-config.ini} should be replaced with the name of the config file you 
    98created earlier. 98created earlier. 
    99 99 
    100 100 
    101As a developer: 101As a developer: 
    102=============== 102=============== 
    103 103 
    1040. Copy development.ini.tmpl to development.ini and edit to your taste. 1040. Copy development.ini.tmpl to development.ini and edit to your taste. 
    105 105 
    1061. Check out the administrative commands: $ bin/shakespeare-admin help. 1061. Check out the administrative commands: $ bin/shakespeare-admin help. 
    107 107 
    1082. Run the tests using either py.test of nosetests:: 1082. Run the tests using either py.test of nosetests:: 
    109 109 
    110    $ nosetests shakespeare 110    $ nosetests shakespeare 
    111''' 111''' 
    112__version__ = '0.5dev' 112__version__ = '0.5' 
    113__application_name__ = 'shakespeare' 113__application_name__ = 'shakespeare' 
    114 114 
    115def conf(): 115def conf(): 
    116    import os 116    import os 
    117    defaultPath = os.path.abspath('./development.ini') 117    defaultPath = os.path.abspath('./development.ini') 
    118    envVarName = __application_name__.upper() + 'CONF' 118    envVarName = __application_name__.upper() + 'CONF' 
    119    confPath = os.environ.get(envVarName, defaultPath) 119    confPath = os.environ.get(envVarName, defaultPath) 
    120    if not os.path.exists(confPath): 120    if not os.path.exists(confPath): 
    121        raise ValueError('No Configuration file exists at: %s' % confPath) 121        raise ValueError('No Configuration file exists at: %s' % confPath) 
    122 122 
    123    # register the config 123    # register the config 
    124    import paste.deploy 124    import paste.deploy 
    125    import shakespeare.config.environment 125    import shakespeare.config.environment 
    126    pasteconf = paste.deploy.appconfig('config:' + confPath) 126    pasteconf = paste.deploy.appconfig('config:' + confPath) 
    127 127 
    128    shakespeare.config.environment.load_environment(pasteconf.global_conf, 128    shakespeare.config.environment.load_environment(pasteconf.global_conf, 
    129        pasteconf.local_conf) 129        pasteconf.local_conf) 
    130    from pylons import config 130    from pylons import config 
    131    conf = config 131    conf = config 
    132 132 
    133    # import ConfigParser 133    # import ConfigParser 
    134    # conf = ConfigParser.SafeConfigParser() 134    # conf = ConfigParser.SafeConfigParser() 
    135    # conf.read(confPath) 135    # conf.read(confPath) 
    136 136 
    137    return conf 137    return conf 
    138      138