bookwyrm-social/bookwyrm

Add URLs for Books

Open

#693 opened on Mar 5, 2021

View on GitHubContributor guide
 (4 comments) (8 reactions) (0 assignees)Python (326 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (2,754 stars)
PR merge metrics
 (PR metrics pending)

Description

Many books have their page on the publisher’s website. Those pages could be used as a source to fill in data and a hint about the current publication status if the URL comes to be missing.

Solution

Allow each Work and Edition to list related URLs.

  • Works could have URLs to Wikidata. Maybe an automatic discovery is possible based on ISBN.
  • Editions could lead to their respective publishers based on language or other differences.

Alternatives

The minimum could be a simple array of URLs sorted manually.

Examples

I think MusicBrainz has a good system where you can define the type of URL (official, Wikipedia, Wikidata…).

Contributor guide

Research direction
Review the current data models for Work and Edition in the codebase. Determine where to add URL fields and how to handle multiple URLs per model. Consider using a separate model or a JSON field. Look at MusicBrainz URL type system for inspiration.
Tech stack
python
Domain
full stack
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70