[RFC0011] OpenPecha Catalog on Database

[10zinten]

Table of Contents

• Housekeeping
• Named Concepts
• Summary
• Reference-Level Explanation
• Alternatives
  • Rationale
• Drawbacks
• Useful References
• Unresolved questions
• Parts of the system affected
• Future possibilities
• Infrastructure
• Testing
• Documentation
• Version History
• Recordings
• Work Phases

Housekeeping

Please add ref in specified format into RFC title, e.g [RFC9999] if corresponding RFW is [RFW9999].

Please add into this RFC and related PR's titles [RFC_id] e.g [RFC_9999].

ALL BELOW FIELDS ARE REQUIRED

Named Concepts

Summary

Current OpenPecha's catalog is in this csv file. To make our catalog more robust to enable data integrity and search functionality, we need to store it database.

Reference-Level Explanation

Architecture ture Diagram

ER Diagram

erDiagram
    Pecha {
        string id "Pecha ID"
        string lagacy_id "Old Pecha ID"
        string default_language
        string source "Source of etext"
        string initial_creation_type
        string imported "Imported datetime"
        string last_modified "last modified datatime"
        string source_metadata "source metadata in JSON"
        string licence
        int work_id
        int collection_id
    }

    Work {
        string id
        string title
        string author
    }

    Collection {
        string id
        string title
        string author
    }

    Alignment {
        string id
        string created
    }

    Work ||--|{ Pecha: has
    Collection ||--|{ Pecha: has
    Alignment ||--|{ Pecha: has

Alternatives

csv file:

• current catalog is stored in csv files
  • pecha'
  • works
  • alignments
  • collections

Rationale

csv file:

• difficult to manage the relationship between works, collection, alignments and pechas.
• difficult to search for specific item

Drawbacks

• cloud hosting cost
• since the catalog will be store in relation database, need to perform migration for any change in schema.
• maintaining the catalog service.

Useful References

https://github.com/OpenPecha-Data/catalog

• What similar work have we already successfully completed?
  • None
• Is this something that have already been built by others?
  • No
• What other related learnings we have?
  • NA
• Are there useful academic literature or other articles related with this topic? (provide links)
  • NA
• Have we built a relevant prototype previously?
  • No
• Do we have a rough mock for the UI/UX?
  • Please refer to Reference-Level Explanation
• Do we have a schematic for the system?
  • Please refer to Reference-Level Explanation

Unresolved Questions

• What is there that is unresolved (and will be resolved as part of fulfilling this request)?
• Are there other requests with same or similar problems to solve?

Parts of the System Affected

• Which parts of the current system are affected by this request?
  • OpenPecha Toolkit
• What other open requests are closely related with this request?
  • RFC0008
• Does this request depend on fulfillment of any other request?
  • No
• Does any other request depend on the fulfillment of this request?*
  • No

Future possibilities

• Improved Etext discovery
• Etext version/duplication detection with REST API

Infrastructure

• Frontend:

  • Use bootstrap to build
    • Catalog item list page for
      • works
      • collections
      • alignments
      • pechas
    • Catalog item detail page for
      • work
      • collection
      • alignments
      • pecha
    • Catalog search page

• Backend:

  • use Django to build models
    • work
    • collection
    • alignment
    • pecha
      • use Django to build views/controller for
      • works list
      • work detail
      • collections list
      • alignments list
      • pechas list

• REST API

  • use Django DRF to build REST API endpoints for
    • get work
    • create work
    • update work
    • delete work
    • get collection
    • create collection
    • update collection
    • delete collection
    • get pecha
    • create pecha
    • update pecha
    • delete pecha

Testing

Describe the kind of testing procedures that are needed as part of fulfilling this request.

Documentation

Describe the level of documentation fulfilling this request involves. Consider both end-user documentation and developer documentation.

Version History

History of changes to this RFC. Following semantic versioning pattern and v0.1.2 for style.

Recordings

Links to audio recordings of related discussion.

Work Phases

Non-Coding

Keep original naming and structure, and keep as first section in Work phases section

• [ ] Planning
• [ ] Documentation
• [ ] Testing

Implementation

A list of checkboxes, one per PR. Each PR should have a descriptive name that clearly illustrates what the work phase is about.

[ngawangtrinley]

@ngawangtrinley review this!

[ngawangtrinley]

Elies' comment:

I think we also need to add more fields to the catalog csv (namely software and batch when relevant)