Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Improved streamlit & console dashboards #466

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jmbowman
Copy link
Contributor

Description:

Improved the Streamlit version of the dashboard to be essentially a superset of the console dashboard, with a shared configuration. A major documentation update will be needed soon, but for now I'm getting this up for people to start trying out.

To try out the Streamlit dashboard:

  • Download the latest SQLite database artifact from the repo-health-data job run
  • Either move it to the default location indicated in Makefile or set the corresponding environment variable to point to it
  • Run make streamlit

Screenshot:

Screenshot 2023-12-22 at 11 59 27 AM

Merge checklist:

  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Improved the streamlit version of the dashboard to be essentially a superset
of the console dashboard, with a shared configuration.  A major documentation
update will be needed soon, but for now I'm getting this up for people to start
trying out.
Copy link

codecov bot commented Dec 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f5061df) 75.03% compared to head (2088af6) 75.08%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #466      +/-   ##
==========================================
+ Coverage   75.03%   75.08%   +0.04%     
==========================================
  Files          26       26              
  Lines        1514     1513       -1     
==========================================
  Hits         1136     1136              
+ Misses        378      377       -1     
Flag Coverage Δ
unittests 75.08% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

# For opening files in a browser. Use like: $(BROWSER)relative/path/to/file.html
BROWSER := python -m webbrowser file://$(CURDIR)/

help: ## display this help message
@echo "Please use \`make <target>' where <target> is one of"
@awk -F ':.*?## ' '/^[a-zA-Z]/ && NF==2 {printf "\033[36m %-25s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort

generate_sqlite: ## generate the repo health SQLite data file from a local checkout of the repo-health-data repository
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This takes about 9 seconds on my laptop, so arguably a good alternative to downloading the database artifact. I want to write up a doc comparing the different download/generation options after the holiday break.

- title: Missing Python 3.8 Classifier
sql: SELECT repo_name, ownership_squad FROM dashboard_main WHERE setup_py_pypi_name IS NOT NULL AND setup_py_pypi_name != '' AND setup_py_py38_classifiers = 0
description: All our packages should work with Python 3.8, and setup.py should declare this explicitly when true to inform users and aid in future upgrades.

- title: Still Have Some Dependencies Not Tested With Django 3.2
sql: SELECT repo_name, ownership_squad, django_packages_total_count - django_packages_upgraded_count FROM dashboard_main WHERE django_packages_total_count > django_packages_upgraded_count
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be great to have a check listing just the packages that don't seem to support Django 3.2, right now it would take some fancy post-processing to create that for the dashboard. Also, we should update this for 4.2. I'll ticket this after the holidays if it hasn't been resolved by then.

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