Skip to content

#131 development for Inactive Dashboard #132

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

stevenrayhinojosa-gmail-com

Summary
This pull request improves developer onboarding for the pyos-packages dashboard by adding clear setup instructions, workflow documentation, and a troubleshooting guide. It addresses Issue #131.

What's Included

  • New Developer Guide
  • Created docs/pyos-package-dashboard-dev.md
  • Explains how to set up, edit, test, and contribute to the package-activity.qmd dashboard
  • Includes both Nox-based and manual Python setup options

Environment Setup Instructions

  • Python 3.9 and 3.10+ setup workflows
  • Quarto installation and verification steps
  • Python dependencies listed with requirements.txt usage
  • Nox Workflow Documentation

Instructions for using:

  • nox -s html for building the site
  • nox -s serve for live preview and auto-reload
  • Explanation of Nox benefits and session behaviors

Dashboard Structure Overview

  • Describes the purpose of package-activity.qmd
  • Explains data sources, file layout, and metrics extracted from gh_meta
  • Includes guidance on editing common components like tables and charts

Goals

  • Make it easier for new contributors to get started
  • Reduce setup errors related to Python or Quarto
  • Provide consistent workflow guidance using Nox or manual setup
  • Clarify dashboard functionality and structure

Related Issue

Steven Hinojosa added 2 commits July 13, 2025 10:51
- Add new pyos-packages section with package activity dashboard
- Track last commit dates and identify inactive packages (6+ months)
- Add sortable tables for all packages and inactive packages
- Update existing package dashboard with activity tracking features
- Reorganize navigation to group package-related metrics
- Remove pyosmetrics dependency to fix Python 3.9 compatibility

Closes pyOpenSci#100
- Add comprehensive workflow documentation for package-activity.qmd
- Include Nox-based development instructions
- Focus on inactive package identification (6+ months)
- Provide setup, testing, and troubleshooting guidance
- Create docs directory structure with README

Related to pyOpenSci#131
# Nox will handle the rest automatically
```

### Alternative: Manual Python Setup
Copy link
Member

Choose a reason for hiding this comment

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

If the user uses nox, then they don't actually need to create a venv because nox does that for them so i'm not sure about this section.

we could add a sentence that says "python should be installed". And probably using uv to install Python is ideal but i'd just suggest that people install a current version of python (not 3.9).

Copy link
Member

@lwasser lwasser left a comment

Choose a reason for hiding this comment

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

hey @stevenrayhinojosa-gmail-com we won't be able to merge this as is as it needs a good bit of work. I really appreciate your attending our sprint. Do you have time to make some updates or help me understand what your goal is with the docs in this pr?

And also i'd remove the dashboard content and have a docs pr be completely separate for easier review.

# - Watch for file changes and rebuild automatically
```

### Manual Workflow (Alternative)
Copy link
Member

Choose a reason for hiding this comment

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

The point of using nox is to avoid this section altogether.

@@ -14,37 +14,36 @@ execute:
import ast
Copy link
Member

Choose a reason for hiding this comment

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

Is the intention to also submit changes to the dashboard through this pr or just documentation? I think this should be two separate pr's.

Choose a reason for hiding this comment

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

Hi, As I remember I was working on the "Inactive Packages" dashboard but then we realized that we also had to lay out the documentation to work on the "Inactive Package" dashboard. I did it backwords and could have provided better direction.

Copy link
Member

Choose a reason for hiding this comment

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

No worries, @stevenrayhinojosa-gmail-com. I do want to merge this PR, but I think we need to make some enhancements to it first.

I am going to test the dashboard locally. What we might consider doing is pulling the dashboard and its commits out and merging it separately from the docs. As the docs we should consolidate into the readme as it makes sense and avoid overlapping information

I appreciate all of your work on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

SOS: inactivedashboard-techstack etc.
2 participants