Skip to content

docs(readme): fix broken examples and export PySUS at the root - #317

Merged
luabida merged 1 commit into
AlertaDengue:mainfrom
luabida:docs/readme-fixes
Aug 14, 2026
Merged

docs(readme): fix broken examples and export PySUS at the root#317
luabida merged 1 commit into
AlertaDengue:mainfrom
luabida:docs/readme-fixes

Conversation

@luabida

@luabida luabida commented Aug 14, 2026

Copy link
Copy Markdown
Member
  • export PySUS from the package root (README promises it)
  • read_parquet returns a DataFrame or DuckDB connection; drop the unconditional .df() chaining in examples
  • fix the test command path (pysus/tests)
  • document DADOSGOV_TOKEN/ACCESS_KEY/SECRET_KEY env vars
  • add DadosGov to the data-source table where applicable

- export PySUS from the package root (README promises it)
- read_parquet returns a DataFrame or DuckDB connection; drop the
  unconditional .df() chaining in examples
- fix the test command path (pysus/tests)
- document DADOSGOV_TOKEN/ACCESS_KEY/SECRET_KEY env vars
- add DadosGov to the data-source table where applicable
@luabida
luabida merged commit 7f46092 into AlertaDengue:main Aug 14, 2026
13 checks passed
@luabida
luabida deleted the docs/readme-fixes branch August 14, 2026 21:43
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@827bbdd). Learn more about missing BASE report.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #317   +/-   ##
=======================================
  Coverage        ?   93.81%           
=======================================
  Files           ?       70           
  Lines           ?    11445           
  Branches        ?        0           
=======================================
  Hits            ?    10737           
  Misses          ?      708           
  Partials        ?        0           

☔ 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.

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.

2 participants