irykson / qbio

CLI tool for simple query a bio of an artist

qbio

This project is a simple utility to query the biography of any artist. It's meant to showcase basic functionalities and some design principles applied with Swift. To showcase these, some implementations are a bit overkill for this kind of application and arguably violate the KISS principle.

Three principles are showcased in particular. A detailed description of these can be found here.

Project structure

The project consists out of two products (to use the Swift Package Manager terminology):

• qbio-lib
  type=library: Implementation of querying the data.
• qbio
  type=executable: Simple CLI application that uses qbio-lib for querying the data.

qbio-lib

The library provides a protocol ArtistDataSource that can be used to implement custom logic and data sources but with an abstract API. AudioDBArtistDataSource is an example implementation that uses The AudioDB via an HTTP-API as the data source.

qbio

The executable uses qbio-lib to query the biography of one or more artists passed by the user. It's using ArgumentParser by Apple to parse and execute the arguments and options passed by the user.

qbio's Issues

Implement Error Handling if no bio is found for artist

Review for potential errors and add error handling in qbio executable

Refactor ArgumentParser to use Apples ArgumentParser

Refactor custom implementation of Argument to use Apples ArgumentParser

Add more functional tests to qbio executable

Currently I can't think of any meaningful tests for the executable. All tests would basically mean to test the framework or qbio_lib which is already tested.

Add documentation for design principles used in this project

Add (meaningful) content to README