StudyPied

pied \ ˈpīd \ adj. • of two or more colors in blotches (Marriam-Webster)

What is StudyPied?

The modern student is commonly tasked with supplementing their learning via the collection and organization of information from a variety of technology based content. StudyPied provides the end user a one-stop-shop gui application to aid in the creation of such organized collections, herein refered to as "study guides" or simple "guides."

Features

• Importing of guides from...
  • Google Drive
  • .Docx (Microsoft Word) files
  • .PDF files
• Guide aides such as...
  • Categorized terms
  • Query editing
  • Searching for terms within large guides
  • Table interpretation
  • Custom collections
• Retrieving data matching term queriesArray from...
  • Quizlet.com
  • Supplied PDFs
  • Dictionary
• Exporting of guides to...
  • Proprietary .GUIDE format
  • Quizlet.com
  • Google Drive
  • .Docx format
  • .PDF format

Utilized Tools and Technologies

StudyPied relies on various RESTful APIs and Java libraries to pull in and manage data from multiple digital and web content sources. These include:

• Kotlin : Chosen for its interoperability with commonly available Java libraries and ease of data management
  • Data classes speed up development times by implementing essential utility functions by default
• Apache APIs
  • Apache HttpComponents : Manages requests for APIs lacking Java bindings
  • Apache POI : Manages reading and writing Microsoft Office formats
• Google APIs
  • Google GSON : Deserializes JSON strings into equivalent Java data objects
  • Google Custom Search JSON/Atom API : Provides various advantages over traditional webservice-specific search requests
    • Utilizes Google's search algorithm to ensure the most pertinent results on the whole of web, or just specific sites
    • Takes care of inexact (mispelled, altnernative name, etc.) queriesArray
  • Google Drive API : Used for import and export to Drive services
• Quizlet API : Retrieves user generated definitions from Quizlet.com

Versioning Plan

The public API is constrained to the StudyGuide and GeneralTerm classes. Modification of these two structures are to be denoted by major version change. Addition of other features such as import/export methods and new data content will be denoted by a minor version change.

• v0.1.0 APUSH specific guide with terms, definitions, queriesArray, and completedness
• v0.2.0 Guide that takes custom delimiters and categories for any topic
• v1.0.0 Simple table interpretation support
• v2.0.0 Images support