Skip to content

docs: correct the install instructions and repoint place resolution - #234

Merged
jm-rivera merged 1 commit into
mainfrom
docs/install-and-resolver-pointers
Aug 14, 2026
Merged

jm-rivera merged 1 commit into
mainfrom
docs/install-and-resolver-pointers

Conversation

@jm-rivera

Copy link
Copy Markdown
Collaborator

The README told readers to run pip install -U "bblocks>=3". That command fails today, because 3.0.0 is unpublished and PyPI serves 2.2.0. The migration section around it described 3.x in the present tense as though it had shipped, so the section now describes 2.x as the installable release and 3.0.0 as pending. It has to move back to the present tense when 3.0.0 is tagged.

The README also pointed readers at bblocks-places for place resolution. Its final release, 0.0.6, directs users to resolvekit, so both mentions point there instead. bblocks has no dependency on resolvekit and still uses country_converter internally, so the guidance is written for consumers doing their own resolution. The Basic Usage snippet called from bblocks import places, an import this package has never had, and now calls rk.bulk. Its install line asks for resolvekit[pandas], since bulk() needs the pandas integration.

The pdf extra that get_dsa() requires is documented in the README, the getting-started page and the DSA importer page. That extra arrives in #233, so merge this after it.

.codegraph/ joins the other local tooling entries in .gitignore.

Two documentation problems are left alone. mkdocs build --strict fails on an orphaned importers/dsa.md that the nav does not list, and on a dead comtrade.un.org link in importers/baci.md. Both predate these changes, and no docs build runs in CI to catch them.

Testing: mkdocs build --strict on Python 3.12, which reports the two pre-existing failures above and no new warnings.

Co-authored-by: Claude noreply@anthropic.com

The README told readers to run `pip install -U "bblocks>=3"`, which
fails because 3.0.0 is not published yet, and pointed them at
bblocks-places, whose final release now directs users to resolvekit.

Co-authored-by: Claude <noreply@anthropic.com>
@codecov

codecov Bot commented Aug 14, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.99%. Comparing base (37ed2c8) to head (ae6a6b2).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #234   +/-   ##
=======================================
  Coverage   97.99%   97.99%           
=======================================
  Files          31       31           
  Lines        2986     2986           
=======================================
  Hits         2926     2926           
  Misses         60       60           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jm-rivera
jm-rivera marked this pull request as ready for review August 14, 2026 16:36
@jm-rivera
jm-rivera merged commit c22745f into main Aug 14, 2026
9 checks passed
@jm-rivera
jm-rivera deleted the docs/install-and-resolver-pointers branch August 14, 2026 16:36

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ae6a6b240d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
The DSA importer (`get_dsa`) parses PDF tables and needs the `pdf` extra:

```bash
pip install "bblocks[pdf]"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Add the pdf extra before documenting it

In this commit's tree, pyproject.toml declares only the all and data-importers extras, while camelot-py remains a core dependency. Consequently, this command cannot select the promised PDF dependency set and the documentation incorrectly tells users that get_dsa requires an extra that the released package metadata does not provide. Add the extra in the same change or retain the existing installation guidance until it exists.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant