User:Tachyons/GSoC-Malayalagrandham

Problem description

Malayala Grantha Vivaram is a project intended to make available reliable bibliographic information on all Malayalam books published in Kerala and elsewhere,It has its inspiration from the Malayalam Granthasooji in print envisaged and implemented by K M Govi. Aim of this project is to complete the digitization and documentation of malayalam books database and create an easy way to add and retrieve and update the database, The project should have interface to

• . Guest readers who just ant to access the data

• . People who are interested to contribute

• . publishers through with they can contribute their publication bibliography

• . Application developers who want to use database

• . Libraries which needs to indexed in malayalagrandham database

Implementation plan

The project consists of three components

1. Web Interface for Accessing and Updating Data

2. API for third party apps

3. An offline desktop client

Web Interface for Accessing and Updating Data

Web inter face is the most important part of this project . It must have have an easy to use ui security. User must be able to access data without log in in. It should also provide interface for contributors to add and update database. Selected users with admin will get access to review queue . In review queue , they can approve, reject or improve the edits and additions by contributors

Language frame work :Django and Bootsrap

Libraries : pymarc

API for third party apps

The digitalized database must be useful to all . Any app developer who need this database for their apps must be able to access db using this API . API should also provide option for updating database so that people can write tools for contributing to database .contributions through this API must pass through review queue . API must have complete documentation

An offline desktop client

This is the official desktop client using malayalagradham API, It must be cross plat form should work offline . It should also have feature for updating database in online or using downloaded database from malayala grandham website

Language and toolkit : C++ and Qt

Functional and non functional requirements

1. ISBN support

2. Qr code builder with malayala grandhavivaramweb ui link

3. Interface for crowd sourced contribution

4. MARC21and MARCXML support

5. Facility for adding copyright expired books to malaylagrandha vivaram with wiki books

Deliverables

1. A free reusable databse for malayalm books
2. Web ui for accessing and modifying database
3. API with complete documentation 
4. Proper documentation and tests for the above-mentioned components.

Timeline

This week-by-week timeline provides a rough guideline of how the project will be done.

Pre GSoC

1. Refreshing python and DJango frame work

2. Familiarizing marcxml and marc21 format

3. Familiarizing Qr code

4. Familiarizing API management

5. Refreshing c++ and QT

6. Familiarize with existing database and code base

week 1 and 2

1. Restructure database

2. Implement marc21 structure

3. Create basic web ui

4. ADD support for editing and updating database

week 3 and 4

1. Implement review queue

2. Prevention from spam inputs

3. Implement ui for publishers

4. Implement QR code

5. Document existing components

week 5 and 6

1. API building

2. document API

Start Desktop ui using Qt

Week 7-11 1. Testing

2. Debugging

3. complete Desktop ui

Week 12

Feed backs from community

1.Improve API documentation

2. Add examples for various languages

Week 13

1. Extra week to compensate unexpected delays

Post Gsoc Maintenance

Personal information

Email Address: aboobackervyd@gmail.com

Telephone:9400113717

Blog URL: abvayad.wordpress.com ( empty)

Freenode IRC Nick: tachyons

University and current education: CUSAT , B tech computer science

Why do you want to work with the Swathanthra Malayalam Computing?

I am malayalee and a foss enthusiast .I believe that I have responsibility to contribute to this project , because Iam using softares which are contributed by 100s of developers .

Do you have any past involvement with the Swathanthra Malayalam Computing or another open source project as a contributor? Unfortunately , I did`t contribute significanatly. I helped for translation of some projects from launchpad , ad now I am creating GTK3ui for apertium machine language translator project

Did you participate with the past GSoC programs, if so which years, which organizations? No

Do you have other obligations between May and August ? Please note that we expect the Summer of Code to be a full time, 40 hour a week commitment Our class will start on june last weekor july . So it may effect slightly. But coding is my hobby so It will not effect significanlly. Iam pretty sure that I can complete project before dead line

Will you continue contributing/ supporting the Swathanthra Malayalam Computing after the GSoC 2013 program, if yes, which area(s), you are interested in?

Yes, Because it is my responsibility I will contribute even if I am not selected for GSoC. My interests are machine language translator for malayalam and SILPA project

Why should we choose you over other applicants?