How sonusajith/ossustain works
OSSustain is a research system for early warning of contribution-activity decline in public GitHub repositories. Its workflow selects a cohort, collects repository and collaboration history, validates quality, builds snapshots and labels, then trains/evaluates models and produces predictions for the dashboard. The Spring API serves stored repository and research results; the React app presents cohort, repository-detail, research-results, and methodology views. Pipeline stage ordering and dashboard capabilities are documented in the README; some stage internals and backend analytics implementations were not sampled, so their internal connections are omitted.
Main entry points: cli.py Pipeline CLI · App.tsx Dashboard routing · client.py GitHub REST client · runner.py Repository collection
Components 28
Research pipeline
- Pipeline CLI
pipeline/src/ossustain_pipeline/cli.py - Cohort selection
pipeline/src/ossustain_pipeline/cohort.py - Repository collection
pipeline/src/ossustain_pipeline/collect/runner.py - Collaboration collection
pipeline/src/ossustain_pipeline/collect/collaboration.py - GitHub REST client
pipeline/src/ossustain_pipeline/github/client.py - Privacy-filtered cache
pipeline/src/ossustain_pipeline/github/cache.py - Collection storage
pipeline/src/ossustain_pipeline/collect/store.py - Collection validation
pipeline/src/ossustain_pipeline/collect/validation.py - Feature generation
pipeline/src/ossustain_pipeline/features/runner.py - Snapshots and labels
pipeline/src/ossustain_pipeline/snapshots/runner.py - Model training and evaluation
pipeline/src/ossustain_pipeline/modeling/runner.py - Prediction generation
pipeline/src/ossustain_pipeline/predictions/runner.py
Read API
- API application
backend/src/main/java/org/ossustain/OssustainApplication.java - Repository endpoints
backend/src/main/java/org/ossustain/api/repository/RepositoryController.java - Repository reads
backend/src/main/java/org/ossustain/api/repository/RepositoryReadService.java - Repository analytics
backend/src/main/java/org/ossustain/api/repository/RepositoryAnalyticsReadService.java - Research endpoints
backend/src/main/java/org/ossustain/api/research/ResearchController.java - Research reads
backend/src/main/java/org/ossustain/api/research/ResearchReadService.java
Dashboard
- Dashboard routing
frontend/src/App.tsx - Cohort overview
frontend/src/features/cohort/CohortOverview.tsx - Repository detail
frontend/src/features/repository/RepositoryDetailPage.tsx - Research results
frontend/src/features/research/ResearchResultsPage.tsx - Methodology view
frontend/src/features/research/MethodologyPage.tsx - API query hooks
frontend/src/api/queries.ts - API client
frontend/src/api/client.ts
Other components
- Researcher
- PostgreSQL
- GitHub API
Connections 35
- Researcher → Pipeline CLI: runs stages
README.md - Pipeline CLI → Cohort selection: selects cohort
pipeline/src/ossustain_pipeline/cli.py - Pipeline CLI → Repository collection: runs collection
pipeline/src/ossustain_pipeline/cli.py - Pipeline CLI → Collaboration collection: runs collection
pipeline/src/ossustain_pipeline/cli.py - Pipeline CLI → Collection validation: runs validation
pipeline/src/ossustain_pipeline/cli.py - Pipeline CLI → Feature generation: runs features
pipeline/src/ossustain_pipeline/cli.py - Pipeline CLI → Snapshots and labels: builds snapshots
pipeline/src/ossustain_pipeline/cli.py - Pipeline CLI → Model training and evaluation: runs modeling
pipeline/src/ossustain_pipeline/cli.py - Pipeline CLI → Prediction generation: generates predictions
pipeline/src/ossustain_pipeline/cli.py - Repository collection → GitHub REST client: requests history
- Collaboration collection → GitHub REST client: requests collaboration
- GitHub REST client → GitHub API: sends REST requests
pipeline/src/ossustain_pipeline/github/client.py - GitHub REST client → Privacy-filtered cache: reads cached responses
pipeline/src/ossustain_pipeline/github/client.py - Repository collection → Collection storage: stores progress
README.md - Collaboration collection → Collection storage: stores collection
README.md - Collection validation → PostgreSQL: checks collected data
- Snapshots and labels → PostgreSQL: reads collection
README.md - Model training and evaluation → PostgreSQL: persists results
pipeline/src/ossustain_pipeline/modeling/runner.py - Prediction generation → PostgreSQL: stores predictions
- Researcher → Dashboard routing: views dashboard
README.md - Dashboard routing → Cohort overview: routes to
frontend/src/App.tsx - Dashboard routing → Repository detail: routes to
frontend/src/App.tsx - Dashboard routing → Research results: routes to
frontend/src/App.tsx - Dashboard routing → Methodology view: routes to
frontend/src/App.tsx - Repository detail → API query hooks: loads repository data
frontend/src/features/repository/RepositoryDetailPage.tsx - Research results → API query hooks: loads results
frontend/src/features/research/ResearchResultsPage.tsx - API query hooks → API client: calls API
frontend/src/api/queries.ts - API client → Repository endpoints: requests repository data
- API client → Research endpoints: requests research data
- Repository endpoints → Repository reads: delegates repository reads
backend/src/main/java/org/ossustain/api/repository/RepositoryController.java - Repository endpoints → Repository analytics: delegates analytics
backend/src/main/java/org/ossustain/api/repository/RepositoryController.java - Research endpoints → Research reads: delegates research reads
backend/src/main/java/org/ossustain/api/research/ResearchController.java - Repository reads → PostgreSQL: queries repository data
- Repository analytics → PostgreSQL: queries analytics
- Research reads → PostgreSQL: queries research data
backend/src/main/java/org/ossustain/api/research/ResearchReadService.java