User:Tachyons/GSoC-Malayalagrandham: Difference between revisions

From SMC Wiki
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:


== '''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.
== An overview of your proposal ==
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
 
 
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
* Contributers
* publishers through with they can contribute their publication bibliography
* Application developers who want to use database
* Libraries which needs to indexed in malayalagrandham database
* Reviewrs who have privilage to approve/reject suggestions from contributers
   
   
*. Guest readers who just ant to access the data
*. People who are interested to contribute


*. publishers through with they can contribute their publication bibliography
== The need you believe it fulfills ==


*. Application developers who want to use database
* User friendly interface for crowd contributers and reviwers
* Quick acess of data without registration
* RESTFul API
* Facility for searching data using name or ISBN
* Proper doumenttation of API
* An offline client (Low priority)
* Module for creating QR code with malayala grandhavivaramweb ui link
* Export data to marc21 and marcxml format
* Facility for adding copyright expired books to malaylagrandha vivaram with the integration of wiki books
* A dynamic visualisation interface for book information browsing


*. Libraries which needs to indexed in malayalagrandham database
== Any relevant experience you have ==
I am familiar with webapplication with php and Django


== Implementation plan ==


''The project consists of three components''
== How you intend to implement your proposal ==
 
1. Web Interface for Accessing and Updating Data
I would like to implement this proposal using Django framework and Mysql/MariaDB in the backend
Libraries to use
* [https://github.com/edsu/pymarc pymarc] (for manipulating marcformats)
* [https://pypi.python.org/pypi/django-qrcode django-qrcode]
* Qt (Desktop ui)
* Twitter Bootstrap (front end


2. API for third party apps


3. An offline desktop client


'''Web Interface for Accessing and Updating Data'''
'''Web Interface for Accessing and Updating Data'''
Line 35: Line 54:
'''API for third party apps'''
'''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
The digitized   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 . If the application requires insert or update operations , It must obtain valid developer key from malayalagrandham website


'''An offline desktop client'''
'''An offline desktop client'''
Line 41: Line 60:
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
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''
== A rough timeline for your progress with phases ==
 
   
== 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'''
'''Pre GSoC'''


1. Refreshing python and DJango frame work
* Refreshing python and DJango frame work


2. Familiarizing marcxml and marc21 format
* Familiarizing marcxml and marc21 format


3. Familiarizing Qr code
* Familiarizing Qr code


4. Familiarizing API management
* Familiarizing API management


5. Refreshing c++ and QT
* Refreshing c++ and QT


6. Familiarize  with existing database and code base
* Familiarize  with existing database and code base


'''week 1 and 2'''
'''week 1 and 2'''


1. Restructure database
* Restructure database


2. Implement marc21 structure  
* Implement marc21 structure  


3. Create basic web ui
* Create basic web ui


4. ADD support for editing and updating database
* ADD support for editing and updating database


'''week 3 and 4'''
'''week 3 and 4'''


1. Implement review queue
*. Implement review queue


2. Prevention from spam inputs
*. Prevention from spam inputs


3. Implement ui for publishers
* Implement ui for publishers


4. Implement QR code
* Implement QR code


5. Document existing components
* Document existing components


'''week 5 and 6'''
'''week 5 and 6'''


1. API building
* API building


2. document API
* document API


Start Desktop ui using Qt
Start Desktop ui using Qt


'''Week 7-11'''
'''Week 7-11'''
1. Testing
*. Testing


2. Debugging
* Debugging


3. complete Desktop ui
* complete Desktop ui


'''Week 12'''
'''Week 12'''
Line 122: Line 117:
Feed backs from community
Feed backs from community


1.Improve API documentation  
* Improve API documentation  


2. Add examples for various languages
2. Add examples for various languages
Line 128: Line 123:
'''Week 13'''
'''Week 13'''


1. Extra week to compensate unexpected delays
* Extra week to compensate unexpected delays


'''Post Gsoc'''
'''Post Gsoc'''
Maintenance


* Maintenance
== Tell us about something you have created. ==
Here is  my github profile https://github.com/tachyons
* Placement cell management system for a college
* A simple  GTK3 ui for English malayalam Dictionary
* User interface for apertium project ( under construction)


== Personal information ==
== Have you communicated with a potential mentor? If so, who? ==
Yes , I have communicated with Anivar Aravind


'''Email Address''':  ''aboobackervyd@gmail.com''


'''Telephone''':''9400113717''
== SMC Wiki link of your proposal ==
http://wiki.smc.org.in/User:Tachyons/GSoC-Malayalagrandham


'''Blog URL''': ''abvayad.wordpress.com ( empty)''
== Personal information ==


'''Freenode IRC Nick''': ''tachyons''
Email Address      : aboockervyd@gmail.com
Blog URL            : abvayad.wordpress.com
Freenode IRC Nick   : tachyons
Your university and current education: CUSAT , B Tech Computer science


University and current education: ''CUSAT , B tech computer science''


'''Why do you want to work with the Swathanthra Malayalam Computing?'''
'''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 .''
I heard about smc by accident . I saw the mailing list from launchapad when I was helping one project for malayalam translation. I joined in that mailing list and really surprised with dedication of smc members for malayalam language computing. I asked to one of the members about the reason behind this dedication . His answer was simple "I am a malayalee ,It is our responsibility" . As a malayalee I also have responsibility to complete the dream "എന്റെ കമ്പ്യൂട്ടറിനു് എന്റെ ഭാഷ". So I decided to contribute to smc in this summer . I will work for smc even if I am not selected for GSoc , Because It is my responsibility
 
'''Do you have any past involvement with the Swathanthra Malayalam Computing or another open source project as a contributor?'''


I don't have considerable contribution to opensource projects .But I hope I can involve in open source projects in future
here is my github profile [https://github.com/tachyons tachyons]


'''Do you have any past involvement with the Swathanthra Malayalam Computing or another open source project as a contributor?
'''Did you participate with the past GSoC programs, if so which years, which organizations?'''
'''
''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''


No


'''Did you participate with the past GSoC programs, if so which years, which organizations?'''
'''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
''No''
commitment'''


NO , I don't have such obligations


'''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'''
'''Will you continue contributing/ supporting the Swathanthra Malayalam Computing after the GSoC 2013 program, if yes, which area(s), you are interested in?'''
''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''


Yes I will , My interested fields are


'''Will you continue contributing/ supporting the Swathanthra Malayalam Computing after the GSoC 2013 program, if yes, which area(s), you are interested in?'''
* Machine language translation system for malayalam
 
* Malayalam Speech Recognition
''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''
* Malayalam text to speech(Improving Dhani)


'''Why should we choose you over other applicants?'''
'''Why should we choose you over other applicants?'''
 
I am a foss enthusiast and technology enthusiast. I am new to the field of digital sound processing ,But I have knowledge about digital signal processing  and have solid background in major programming languages . I also planned to create a similar project as the academic project , So that I can spend more time and effort for this project

Latest revision as of 18:11, 3 May 2013


An overview of your proposal

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
  • Contributers
  • publishers through with they can contribute their publication bibliography
  • Application developers who want to use database
  • Libraries which needs to indexed in malayalagrandham database
  • Reviewrs who have privilage to approve/reject suggestions from contributers


The need you believe it fulfills

  • User friendly interface for crowd contributers and reviwers
  • Quick acess of data without registration
  • RESTFul API
  • Facility for searching data using name or ISBN
  • Proper doumenttation of API
  • An offline client (Low priority)
  • Module for creating QR code with malayala grandhavivaramweb ui link
  • Export data to marc21 and marcxml format
  • Facility for adding copyright expired books to malaylagrandha vivaram with the integration of wiki books
  • A dynamic visualisation interface for book information browsing

Any relevant experience you have

I am familiar with webapplication with php and Django


How you intend to implement your proposal

I would like to implement this proposal using Django framework and Mysql/MariaDB in the backend Libraries to use

  • pymarc (for manipulating marcformats)
  • django-qrcode
  • Qt (Desktop ui)
  • Twitter Bootstrap (front end


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 digitized 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 . If the application requires insert or update operations , It must obtain valid developer key from malayalagrandham website

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

A rough timeline for your progress with phases

Pre GSoC

  • Refreshing python and DJango frame work
  • Familiarizing marcxml and marc21 format
  • Familiarizing Qr code
  • Familiarizing API management
  • Refreshing c++ and QT
  • Familiarize with existing database and code base

week 1 and 2

  • Restructure database
  • Implement marc21 structure
  • Create basic web ui
  • ADD support for editing and updating database

week 3 and 4

  • . Implement review queue
  • . Prevention from spam inputs
  • Implement ui for publishers
  • Implement QR code
  • Document existing components

week 5 and 6

  • API building
  • document API

Start Desktop ui using Qt

Week 7-11

  • . Testing
  • Debugging
  • complete Desktop ui

Week 12

Feed backs from community

  • Improve API documentation

2. Add examples for various languages

Week 13

  • Extra week to compensate unexpected delays

Post Gsoc

  • Maintenance


Tell us about something you have created.

Here is my github profile https://github.com/tachyons

  • Placement cell management system for a college
  • A simple GTK3 ui for English malayalam Dictionary
  • User interface for apertium project ( under construction)

Have you communicated with a potential mentor? If so, who?

Yes , I have communicated with Anivar Aravind


SMC Wiki link of your proposal

http://wiki.smc.org.in/User:Tachyons/GSoC-Malayalagrandham

Personal information

Email Address       : aboockervyd@gmail.com
Blog URL            : abvayad.wordpress.com
Freenode IRC Nick   : tachyons
Your university and current education: CUSAT , B Tech Computer science


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

I heard about smc by accident . I saw the mailing list from launchapad when I was helping one project for malayalam translation. I joined in that mailing list and really surprised with dedication of smc members for malayalam language computing. I asked to one of the members about the reason behind this dedication . His answer was simple "I am a malayalee ,It is our responsibility" . As a malayalee I also have responsibility to complete the dream "എന്റെ കമ്പ്യൂട്ടറിനു് എന്റെ ഭാഷ". So I decided to contribute to smc in this summer . I will work for smc even if I am not selected for GSoc , Because It is my responsibility

Do you have any past involvement with the Swathanthra Malayalam Computing or another open source project as a contributor?

I don't have considerable contribution to opensource projects .But I hope I can involve in open source projects in future here is my github profile tachyons

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

NO , I don't have such obligations

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

Yes I will , My interested fields are

  • Machine language translation system for malayalam
  • Malayalam Speech Recognition
  • Malayalam text to speech(Improving Dhani)

Why should we choose you over other applicants?

I am a foss enthusiast and technology enthusiast. I am new to the field of digital sound processing ,But I have knowledge about digital signal processing and have solid background in major programming languages . I also planned to create a similar project as the academic project , So that I can spend more time and effort for this project