Including upstream list as submodule/subtree would be more transparent

Open
#13 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
git, python

Research direction

Start by inspecting how the existing public_suffix_list.dat is included in python-publicsuffix2 builds and how releases create archives. Compare a subtree or submodule against the repository's packaging flow, using the upstream publicsuffix/list file as the source. Done means builds no longer download the list and both the wheel and tagged-release archive contain a reproducible bundled version.

Written by the indexing model from the issue text.

Description

During packaging of python-publicsuffix2 I realized, that downloading the publicsuffix list during build time makes it unreproducible (any time the package is rebuilt, it will have a different list).

My suggestion would be to include the publicsuffix list from upstream directly as e.g. a git submodule or git subtree (the latter is preferred as this way the files actually end up in an automatically generated tarball on github when tagging a release) and not download it during build time at all to ensure reproducibility raise transparency.
The data lives in this repository already, so it could also be copied manually, but IMHO a subtree or submodule is the more transparent way of dealing with this.

Currently only the wheel on pypi.org is really ensured to carry the currently bundled version of the publicsuffix list. For anyone else building this package, this assumption is not valid.

Dominant language
Python
Stars
31
Forks
16
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aboutcode-org/python-publicsuffix2

All issues in aboutcode-org/python-publicsuffix2

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.