Skip to content

OSL Internship ‐ 2024 ‐ 2nd Cycle

Ivan Ogasawara edited this page Apr 17, 2024 · 3 revisions

ArtBox


Abstract

ArtBox is a tool set for handling multimedia files with a bunch of useful functions.

Key Features:

  • Convert text to audio
  • Download a youtube video
  • Create a song based on the musical notes
  • Remove the audio from a video
  • Extract the audio from a video
  • Combine audio and video files

This proposal aims to improve the documentation and the tutorials


Project Idea 1: Improve ArtBox documentation and create tutorials

Current State

The current documentation structure is just an initial version from scicookie template.

Tasks

Expected Outcomes

  • Improved documentation with updated information
  • Improved the documentation configuration (mkdocs)
  • a series of 6 tutorials about how to use artbox with real examples
  • publish it in other tech blog medias

Details

  • Prerequisites:
    • Python
    • Object-oriented programming (OOP)
    • YAML
  • Expected Time: 350 hours Potential Mentor(s): Ivan Ogasawara

Project Idea 2: Split ArtBox in API and CLI

Current State

Currently, ArtBox just offer a CLI. We need to break it down into API and CLI, so people could use artbox as a library as well with the same functionalities.

Tasks

  • break down ArtBox in API and CLI
  • refactor the current classes to be use as an API

Expected Outcomes

  • ArtBox should be able to be executed as CLI or API

Details

  • Prerequisites:
    • Python
    • Object-oriented programming (OOP)
    • YAML
  • Expected Time: 350 hours Potential Mentor(s): Ivan Ogasawara