Changeset 120

Show
Ignore:
Timestamp:
04/10/07 15:17:40 (2 years ago)
Author:
rgrp
Message:

micro: tiny change to short description of the project.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • annotater/trunk/README.txt

    Revision 117 Revision 120
    1## Introduction 1## Introduction 
    2 2 
    3Annotater is a web annotation system for python built on Geof Glass' 3Annotater is a inline web annotation system for python built on Geof Glass' 
    4[marginalia]. 4[marginalia]. 
    5 5 
    6[marginalia]: http://www.geof.net/code/annotation 6[marginalia]: http://www.geof.net/code/annotation 
    7 7 
    8 8 
    9## Copyright and License 9## Copyright and License 
    10 10 
    11Copyright (c) 2006-2007 the Open Knowledge Foundation. 11Copyright (c) 2006-2007 the Open Knowledge Foundation. 
    12 12 
    13All parts deriving directly from Geof Glass' code are (c) Geoff Glass and 13All parts deriving directly from Geof Glass' code are (c) Geoff Glass and 
    14collaborators and are licensed under the GPL v2. 14collaborators and are licensed under the GPL v2. 
    15 15 
    16All other code licensed under the MIT license: 16All other code licensed under the MIT license: 
    17 17 
    18  <http://www.opensource.org/licenses/mit-license.php> 18  <http://www.opensource.org/licenses/mit-license.php> 
    19 19 
    20 20 
    21## Getting Started 21## Getting Started 
    22 22 
    23You can start the demo web application: 23You can start the demo web application: 
    24 24 
    25    $ python demo/demo.py 25    $ python demo/demo.py 
    26 26 
    27You'll then find an annotable web page presented at <http://localhost:8080/> 27You'll then find an annotable web page presented at <http://localhost:8080/> 
    28 28 
    29Try it out. 29Try it out. 
    30 30 
    31 31 
    32## Technical Information 32## Technical Information 
    33 33 
    34Annotater is derived into 2 parts: 34Annotater is derived into 2 parts: 
    35 35 
    361. A annotation storage backend providing a web and RESTful interface 361. A annotation storage backend providing a web and RESTful interface 
    37 37 
    382. A web application that uses the marginalia javascript to provide javascript 382. A web application that uses the marginalia javascript to provide javascript 
    39based web annoation. 39based web annoation. 
    40 40 
    41 41 
    42### Specification of the Annotation Store 42### Specification of the Annotation Store 
    43 43 
    44The RESTful interface is defined by python routes commmand: 44The RESTful interface is defined by python routes commmand: 
    45 45 
    46map.resource('annotation') 46map.resource('annotation') 
    47 47 
    48That is, the store is mounted at url /annotation/ and supports a restful 48That is, the store is mounted at url /annotation/ and supports a restful 
    49interface as defined in the [routes docs]. 49interface as defined in the [routes docs]. 
    50 50 
    51[routes docs]: http://routes.groovie.org/manual.html 51[routes docs]: http://routes.groovie.org/manual.html 
    52 52 
    53There are a few additions to ensure compatibility with the marginalia 53There are a few additions to ensure compatibility with the marginalia 
    54javascript front-end as well as to support a better 'human' web interface. 54javascript front-end as well as to support a better 'human' web interface. 
    55These are most easily seen by looking at the routes commands at the top of 55These are most easily seen by looking at the routes commands at the top of 
    56annotater.py. 56annotater.py. 
    57 57 
    58An annotation: see the definition Annotation in model.py (the domain model 58An annotation: see the definition Annotation in model.py (the domain model 
    59file). 59file). 
    60 60 

  • annotater/trunk/setup.py

    Revision 106 Revision 120
    1from setuptools import setup, find_packages 1from setuptools import setup, find_packages 
    2 2 
    3from annotater import __version__ 3from annotater import __version__ 
    4 4 
    5 5 
    6setup( 6setup( 
    7    name = 'annotater', 7    name = 'annotater', 
    8    version = __version__, 8    version = __version__, 
    9    packages = find_packages(), 9    packages = find_packages(), 
    10    # WARNING: package_data is broken for sdist 10    # WARNING: package_data is broken for sdist 
    11    # see 11    # see 
    12    # http://mail.python.org/pipermail/distutils-sig/2007-February/007216.html 12    # http://mail.python.org/pipermail/distutils-sig/2007-February/007216.html 
    13    # package_data = { 13    # package_data = { 
    14    #    'annotater.marginalia' : ['*.js', '*.css', 'lang/*' ], 14    #    'annotater.marginalia' : ['*.js', '*.css', 'lang/*' ], 
    15    #    }, 15    #    }, 
    16    install_requires = [ 'SQLObject >= 0.7' ], 16    install_requires = [ 'SQLObject >= 0.7' ], 
    17    scripts = [], 17    scripts = [], 
    18 18 
    19    # metadata for upload to PyPI 19    # metadata for upload to PyPI 
    20    author = 'Rufus Pollock (Open Knowledge Foundation)', 20    author = 'Rufus Pollock (Open Knowledge Foundation)', 
    21    author_email = 'rufus@rufuspollock.org', 21    author_email = 'rufus@rufuspollock.org', 
    22    description = \ 22    description = \ 
    23"Web-based inline annotation of a web resource.", 23"Inline web annotation.", 
    24    long_description = \ 24    long_description = \ 
    25""" 25""" 
    26""", 26""", 
    27    license = 'MIT', 27    license = 'MIT', 
    28    keywords = 'annotation web javascript', 28    keywords = 'annotation web javascript', 
    29    url = 'http://p.knowledgeforge.net/shakespeare/svn/annotater/',  29    url = 'http://p.knowledgeforge.net/shakespeare/svn/annotater/',  
    30    download_url = 'http://p.knowledgeforge.net/shakespeare/svn/annotater/trunk', 30    download_url = 'http://p.knowledgeforge.net/shakespeare/svn/annotater/trunk', 
    31    classifiers = [ 31    classifiers = [ 
    32        'Development Status :: 3 - Alpha', 32        'Development Status :: 3 - Alpha', 
    33        'Environment :: Console', 33        'Environment :: Console', 
    34        'Intended Audience :: Developers', 34        'Intended Audience :: Developers', 
    35        'License :: OSI Approved :: MIT License', 35        'License :: OSI Approved :: MIT License', 
    36        'Operating System :: OS Independent', 36        'Operating System :: OS Independent', 
    37        'Programming Language :: Python', 37        'Programming Language :: Python', 
    38        'Topic :: Software Development :: Libraries :: Python Modules'], 38        'Topic :: Software Development :: Libraries :: Python Modules'], 
    39) 39)