Repository navigation
Rewrite the README and notebook, trim the tooling - #3
Merged
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
tests/test_notebook.py.bee-migrationand serving the dashboard. Removed the API, database, cache and monitoring services that had no code behind them, and.env.example.Dockerjob in CI builds the image and runs the analysis in it.pyproject.toml.Notes
LICENSEfile: the repository has none, althoughpyproject.tomldeclares MIT.results/come from the pre-commit hooks.Test plan
pytest— 85 testsnode --test "tests/web/*.test.mjs"— 20 testspre-commit run --all-filescleanDockerjob in CI (not buildable locally: no Docker on the development machine)