Skip to main content

A full open set of Shakespeare's works along with anciallary material, a variety of tools and a python api

Project description

Introduction

The Open Shakespeare package provides a full open set of shakespeare’s works (often in multiple versions) along with ancillary material, a variety of tools and a python API.

Specifically in addition to the works themselves (often in multiple versions) there is an introduction, a chronology, explanatory notes, a concordance and search facilities.

All material is open source/open knowledge so that anyone can use, redistribute and reuse these materials freely. For exact details of the license under which this package is made available please see COPYING.txt.

Open Shakespeare has been developed under the aegis of the Open Knowledge Foundation (http://www.okfn.org/).

Contact the Project

Please mail info@okfn.org or join the okfn-discuss mailing list:

http://lists.okfn.org/listinfo/okfn-discuss

Installation and Setup

1. Install the code

1.1: (EITHER) Install using setup.py (preferred)

Install shakespeare using easy_install:

easy_install shakespeare

NB: If you don’t have easy_install you can get from here:

<http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions>

1.2 (OR) Get the code straight from subversion

  1. Check out the subversion trunk:

    svn co https://knowledgeforge.net/shakespeare/svn/trunk
  2. Do:

    sudo python setup.py develop

Getting Started

As a user:

1. Basic setup

To access most of the main features of Open Shakespeare you need a database. For this an other bits and bobs of configuration you will need a configuration file.

You can make a config file as follows:

paster make-config shakespeare {your-config.ini}

Tweak the config file as appropriate and then setup the application:

paster setup-app config.ini

[TODO: this should be part of setup-app]

Run:

$ shakespeare-admin db init

2. Extras

  1. Search index. [TODO]

2. You can start a web server to provide a easy-to-use web interface to the shakespeare material and facilities by doing:

$ paster serve {your-config.ini}

NB: {your-config.ini} should be replaced with the name of the config file you created earlier.

As a developer:

0. Setup

Follow the basic steps above put with an ini file named: development.ini

NB: you’ll probably want to change log levels to debug.

1. Check out the administrative commands

$ bin/shakespeare-admin help.

2. Run the tests using either py.test of nosetests::

$ nosetests shakespeare

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shakespeare-0.6.tar.gz (5.4 MB view details)

Uploaded Source

Built Distribution

shakespeare-0.6-py2.5.egg (4.4 MB view details)

Uploaded Source

File details

Details for the file shakespeare-0.6.tar.gz.

File metadata

  • Download URL: shakespeare-0.6.tar.gz
  • Upload date:
  • Size: 5.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for shakespeare-0.6.tar.gz
Algorithm Hash digest
SHA256 f393d09d07ea4d0e19957838046b3601ad09e0a5bd1c5ad0454240eacff393be
MD5 3cc70be7fd85b4e1521f52782ddd4fdf
BLAKE2b-256 a445699c3869c2590579d0ef89df3cbd28b17eb77a14dd9f1841c51cd7d4dc1c

See more details on using hashes here.

File details

Details for the file shakespeare-0.6-py2.5.egg.

File metadata

File hashes

Hashes for shakespeare-0.6-py2.5.egg
Algorithm Hash digest
SHA256 296e6eae76c8ff62e10ca0d206da4743f7f462106fc39c576abddfddd3f6d90a
MD5 0969608d4364e097c92b046b9bbfc55d
BLAKE2b-256 fb815ccd99cda5afcb8e36c1542f38ad79d35a1681ecd4b4cc70b1520d6a241d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page