Skip to content

Release: README, tutorial notebook and tooling - #4

Merged
digomes87 merged 6 commits into
mainfrom
develop
Oct 11, 2026
Merged

digomes87 merged 6 commits into
mainfrom
develop

Conversation

@digomes87

Copy link
Copy Markdown
Owner

Summary

Promote develop to main:

  • README rewritten around what the data is and what it does not show
  • Tutorial notebook rewritten and covered by a test
  • Docker, Compose, pre-commit, conda and Makefile reduced to what the project uses

Details are in #3. Merging redeploys the site through the Pages workflow.

State what each dataset is and what it supports, replace the claims the
data does not back with the measured results, and document the command
line, the Python interface and the dashboard.

The notebook was not valid JSON and imported classes that never existed.
It now walks through the package and is executed by the test suite.
- Dockerfile and Compose file run the bee-migration command and serve
  the dashboard; the stages and services for an API, a database, a cache
  and monitoring that do not exist are gone, with the unused .env.example
- CI builds the image and runs the analysis in it
- pre-commit runs ruff, basic file checks and nbstripout
- conda environment and Makefile follow pyproject.toml
Rewrite the README and notebook, trim the tooling
pyproject.toml already declared MIT, but the repository had no license
text for it to refer to.
setuptools rejects license-files next to the legacy table form of the
license field, which broke the package build.
@digomes87
digomes87 merged commit 35aa455 into main Oct 11, 2026
9 checks passed
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