augur icon indicating copy to clipboard operation
augur copied to clipboard

Document Required compiled-into-python support components

Open MoralCode opened this issue 1 month ago • 2 comments

Since getting started with augur this is now the second time i've run into an issue where the fix was "you need to have these development headers for this thing present when you install and/or compile python for python to support "

This issue aims to loosely document those while various refactoring and digging into old parts of the code happens so it can later be turned into docs.

  1. ~~i forget what this was. may need to do some digging to find it~~ this was from a different project
  2. https://stackoverflow.com/a/53698659/3033386 (bz2 support, found while trying to run the metrics unit tests) - its bzip2-devel on fedora

MoralCode avatar Oct 28 '25 22:10 MoralCode

Hi! 👋 I’d like to work on this issue.

Here’s my plan of action:

  • Identify missing development headers: I’ll list out common Python built-in modules (like bz2, sqlite3, ssl, lzma) that fail to build when their corresponding system headers aren’t installed.
  • Verify for Augur: I’ll check Augur’s Dockerfiles and local setup to see which of these dependencies are already included and which ones need to be documented.
  • Reproduce in a clean environment: I’ll run minimal Python containers to confirm which system packages (like libbz2-dev, libsqlite3-dev, etc.) are needed to successfully import these modules.
  • Document the findings: I’ll create or update a developer troubleshooting section that lists:
    • The missing headers and their corresponding modules
    • The required install commands for Debian/Ubuntu (and note equivalents for other OSes if possible)
    • A quick Python check command to verify everything works (e.g. python -c "import bz2, sqlite3, ssl, lzma")

I’d love to get this assigned — it seems like a useful addition for anyone setting up their local or Docker-based dev environment!

Subhi311 avatar Nov 01 '25 02:11 Subhi311

so far this issue is mostly in "info gathering" mode to see what else is needed, so theres mot much to do.

by the end of november ill likely have exercised most of the code within augur and shaken stuff out

MoralCode avatar Nov 06 '25 23:11 MoralCode