Skip to content

bio-tools/biohackathon2025

Bidirectional bridge: GitHub ⇄ bio.tools

Goal: make software metadata painless. This tool extracts high-quality metadata from GitHub repos to build bio.tools entries and uses bio.tools records to propose improvements back to GitHub (badges, descriptions, files). During the BioHackathon it targets GitHub and bio.tools only, but the architecture is intentionally pluggable for more backends later.

Why:

  • Reduces manual work in software metadata curation.
  • Improves repository visibility and discoverability.
  • Closes the loop: metadata is useful in both directions.

Features

Direction What we do Output
GitHub → bio.tools Extract metadata from GitHub repositories JSON bio.tools metatadata
bio.tools → GitHub Propose improvements to GitHub repositories based on bio.tools records PR

Quick start

# clone
git clone https://github.com/bio-tools/biohackathon2025.git
cd biohackathon2025

# install (all groups)
poetry install

# enable quality hooks
poetry run pre-commit install --hook-type pre-commit --hook-type pre-push

Run the API (with auto-reload). Access Swagger at localhost:8000/docs.

poetry run bridge api

Use the CLI:

poetry run bridge cli --help

Documentation

The documentation is available at https://bio-tools.github.io/biohackathon2025/.

Preview on localhost:

poetry run gen-diagrams
poetry run gen-docs
python -m http.server --directory docs/build

Contributing

Contributions are welcome! Please read the CONTRIBUTING or branching, PR rules, and code style. Read the Developer guide for setup and commands.


License

This project is licensed under Apache 2.0. See the LICENSE file for details.

About

Bidirectional bridge: GitHub ⇄ Bio.tools

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Contributors 9

Languages