rufuspollock-okfn / openletters Goto Github PK

Understanding the "Letter Net"

Home Page: http://opencorrespondence.org

Python 98.52% CSS 1.48%

openletters's Introduction

A project which tries to define the social networks that can be defined from
letters written in the nineteenth century. Currently the project focuses on
Charles Dickens but this will be expanded as new datasets are created. 

Project home page (wiki): http://wiki.okfn.org/p/Open_Letters

Installation and Setup
======================

You will need to have python, mercurial, setuptools, virtualenv and pip to
install ``openletters`` (all other dependencies will be automatically installed
using pip)::

    # check out the code to openletters directory
    hg clone https://knowledgeforge.net/letters/hg openletters

    # move into the directory
    cd openletters

    # now install it to virtualenv at ../pyenv-openletters using pip
    pip -E ../pyenv-openletters install -r pip-requirements.txt


Make a config file as follows::

    paster make-config openletters development.ini

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

    paster setup-app config.ini

Then you are ready to go.


Using the Command Line Tools
============================

Our command line tools have been created as `paster commands` (and found in
openletters/cli.py). To get a list do::

    paster -h

And look at commands in openletters section (some of other commands may be
useful to). To get more info on a given command do::

    paster {command} -h

.. _paster commands: http://pythonpaste.org/script/developer.html

openletters's People

Contributors

Stargazers

Watchers

Forkers

spencerx

openletters's Issues

Put the data into timemapper

Get a nice timemap ...

http://timemapper.okfnlabs.org/

All we need is to convert data => csv => google docs spreadsheet

@austgate wdyt?

Help and Contact us

These need changing and updating as pointing to defunct list and repo

Improve the index pages

Add some jQuery or some such for better user experience

Templates for navigation and footer

Need to develop a frame template(s) for the site so that it has a uniform navigation and footer.

Create API

The idea of an API was mentioned previously.

This code has been untouched for a number of years, and could use some developer love. There are people around the world who may be depending on this content being accessible. Adding security features, checking up on much overdue issues, and of course updating the underlying datasets is something this community would very much appreciate. Nevertheless, it is being archived until such time as there is renewed interest in maintenance.

If you or someone you know can tend to this repository, please drop us a line here: https://discuss.okfn.org/t/winter-maintenance-of-okfn-projects/10116/

Move to Heroku

Here's instructions for flask setup with yourtopia: https://github.com/okfn/yourtopia#deployment

For pylons setup also see: http://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/deployment/heroku.html

Improve the annotations for the OpenLetters: network analysis and so on

Use D3 and Sigma and so on to derive some better visualisations

Update theme

Suggest we bootstrap-ify and use something clean and simple

perhaps put out a call for help on okfn-labs for design assistance?

Refactor OpenLetters into Flask from Pylons

Update the underlying framework

Timeline

Need to either update the timeline using MIT stuff or recreate our own. The original had a speed issue so something to think about.

Home page

Need a simple homepage that introduces the site and also lets users discover the various sections.

Data storage

At the moment, all the data lives in json files. We could store this in a mongo db on heroku… Would that be ok?

Letter clock

We need to either find or regenerate the letter clock that Rufus created.