# frequenz-floss/frequenz-api-common — health index 71/100 (Good)

> Inspection of the public repository frequenz-floss/frequenz-api-common by inspect.software. It holds a health index of 71 out of 100, placing it in the Good band. The index is a signal derived from publicly visible practice, not a warranty, a security audit, or an endorsement, and it is independent of payment.

- Repository: https://github.com/frequenz-floss/frequenz-api-common
- Report page: https://inspect.software/software/frequenz-floss/frequenz-api-common
- Full JSON report: https://inspect.software/api/repositories/frequenz-floss/frequenz-api-common/report
- Badge: https://raw.githubusercontent.com/inspect-software/badges/main/v1/f/frequenz-floss/frequenz-api-common.svg
- Inspected: 2026-07-17
- Methodology: metrics 1.13.0, report schema 0.12.0 (https://inspect.software/methodology.md)

## Category summary

| Category | Weight | Index | Band |
|---|---|---|---|
| Vitality | 22% | 86/100 | Excellent |
| Community & Adoption | 18% | 38/100 | At risk |
| Sustainability & Governance | 24% | 74/100 | Good |
| Engineering Quality | 20% | 84/100 | Good |
| Security | 16% | 65/100 | Moderate |
| AI Readiness | not counted | 48/100 | At risk |

## Repository facts

| Field | Value |
|---|---|
| Description | Shared protobuf definitions and Python bindings for Frequenz APIs |
| Homepage | https://frequenz-floss.github.io/frequenz-api-common/ |
| Primary language | Python |
| License | MIT |
| Stars | 1 |
| Forks | 15 |
| Created | 2023-05-05 |
| Last push | 2026-07-13 |
| Latest release | v0.8.11 |
| Commits (last year) | 180 |
| Bus factor | 2 |
| Topics | api, common, frequenz, grpc, protobuf, python, rpc |

## Published packages

| Registry | Package | Latest | Monthly downloads |
|---|---|---|---|
| pypi | frequenz-api-common | 0.8.11 | — |

## Vitality — 86/100 (Excellent)

Is the project alive — is code being written and are releases shipping? Weight: 22% of the overall index.

### Development activity — 83/100 (Good)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Push recency | met | 36 / 36 | last push 4 days ago |
| Commit cadence | partial | 19.4 / 36 | 28/52 weeks with commits |
| Commit volume | met | 18 / 18 | 180 commits in the last year |
| OpenSSF Scorecard: Maintained | met | 10 / 10 | 30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10 |

### Release discipline — 90/100 (Excellent)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Ships releases | met | 27 / 27 | 28 releases published |
| Release recency | met | 36 / 36 | latest release 4 days ago |
| Release cadence | met | 27 / 27 | a release every ~40.9 days |
| OpenSSF Scorecard: Signed-Releases | not met | 0 / 10 | Project has not signed or included provenance with any releases. |

### Abandonment — 100/100 (Excellent)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Project is still maintained | met | 100 / 100 | maintenance record not established from the collected data |

## Community & Adoption — 38/100 (At risk)

Does the project have users, downloads, attention, and a welcoming setup for contributors? Weight: 18% of the overall index.

### Popularity & adoption — 10/100 (Critical)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Stars | not met | 0 / 60 | 1 stars |
| Forks | partial | 9.6 / 25 | 15 forks |
| Watchers | not met | 0 / 15 | 2 watchers |

### Community health — 70/100 (Good)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| README | met | 22.5 / 22.5 | — |
| License | met | 22.5 / 22.5 | recognized license (MIT) |
| CONTRIBUTING guide | met | 18 / 18 | — |
| Code of conduct | not met | 0 / 13.5 | — |
| Issue template | not met | 0 / 7.2 | — |
| PR template | not met | 0 / 6.3 | — |

## Sustainability & Governance — 74/100 (Good)

Will the project survive its people — bus factor, responsiveness, who backs it, and package upkeep? Weight: 24% of the overall index.

### Maintainer resilience (bus factor) — 64/100 (Moderate)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Bus factor | partial | 25.2 / 54 | 2 contributor(s) cover half of all commits |
| Commit distribution | partial | 14.8 / 22.5 | top contributor authored 34% of commits |
| Contributor breadth | met | 13.5 / 13.5 | 17 contributors |
| OpenSSF Scorecard: Contributors | met | 10 / 10 | project has 7 contributing companies or organizations |

### Issue & PR responsiveness — 77/100 (Good)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Issue resolution | partial | 36.2 / 46.8 | 78% of issues closed |
| PR acceptance | partial | 30.4 / 38.2 | 324/408 decided PRs merged |
| OpenSSF Scorecard: Code-Review | partial | 10.5 / 15 | Found 3/4 approved changesets -- score normalized to 7 |

### Ownership & stewardship — 61/100 (Moderate)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Ownership backing | met | 30 / 30 | organization-owned |
| Verified domain | not met | 0 / 20 | — |
| Owner reach | partial | 9.9 / 25 | 23 followers of frequenz-floss |
| Track record | partial | 20.9 / 25 | 65 public repos, account ~3 yr old |

### Package maintenance — 100/100 (Excellent)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Published & resolvable | met | 25 / 25 | 1 package(s) on pypi |
| Publish recency | met | 35 / 35 | latest publish 4 days ago |
| Version history | met | 20 / 20 | 28 published versions |
| Not deprecated | met | 20 / 20 | active, not deprecated or yanked |

## Engineering Quality — 84/100 (Good)

Are baseline engineering and documentation practices in place? Weight: 20% of the overall index.

### Engineering practices — 74/100 (Good)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| CI workflows | met | 24 / 24 | 10 workflow(s) |
| Tests present | met | 24 / 24 | — |
| Linter config | not met | 0 / 16 | — |
| Pre-commit hooks | not met | 0 / 9.6 | — |
| .editorconfig | met | 6.4 / 6.4 | — |
| OpenSSF Scorecard: CI-Tests | met | 20 / 20 | 10 out of 10 merged PRs checked by a CI test -- score normalized to 10 |

### Documentation — 100/100 (Excellent)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| README | met | 30 / 30 | — |
| Documentation directory | met | 25 / 25 | — |
| Documentation / homepage site | met | 15 / 15 | https://frequenz-floss.github.io/frequenz-api-common/ |
| Repository description | met | 10 / 10 | — |
| Topics | met | 10 / 10 | 7 topics |
| Wiki | met | 10 / 10 | — |

## Security — 65/100 (Moderate)

Are visible security and supply-chain practices strong, with no malicious dependency and no unresolved high-risk jurisdiction exposure? Weight: 16% of the overall index.

### Security posture — 65/100 (Moderate)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Binary-Artifacts | met | 7.5 / 7.5 | no binaries found in the repo |
| Branch-Protection | partial | 3.8 / 7.5 | branch protection is not maximal on development and all release branches |
| CI-Tests | met | 2.5 / 2.5 | 10 out of 10 merged PRs checked by a CI test -- score normalized to 10 |
| CII-Best-Practices | not met | 0 / 2.5 | no effort to earn an OpenSSF best practices badge detected |
| Code-Review | partial | 5.2 / 7.5 | Found 3/4 approved changesets -- score normalized to 7 |
| Contributors | met | 2.5 / 2.5 | project has 7 contributing companies or organizations |
| Dangerous-Workflow | met | 10 / 10 | no dangerous workflow patterns detected |
| Dependency-Update-Tool | met | 7.5 / 7.5 | update tool detected |
| Fuzzing | not met | 0 / 5 | project is not fuzzed |
| License | met | 2.5 / 2.5 | license file detected |
| Maintained | met | 7.5 / 7.5 | 30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10 |
| Packaging | met | 5 / 5 | packaging workflow detected |
| Pinned-Dependencies | met | 5 / 5 | all dependencies are pinned |
| SAST | partial | 2 / 5 | SAST tool is not run on all commits -- score normalized to 4 |
| Security-Policy | not met | 0 / 5 | security policy file not detected |
| Signed-Releases | not met | 0 / 7.5 | Project has not signed or included provenance with any releases. |
| Token-Permissions | not met | 0 / 7.5 | detected GitHub workflow tokens with excessive permissions |
| Vulnerabilities | met | 7.5 / 7.5 | 0 existing vulnerabilities detected |

### High-Risk Jurisdiction Exposure — 100/100 (Excellent)

Only high-confidence self-published location evidence affects this multiplier. Ambiguous matches are review-only; country evidence is not proof of nationality, citizenship, legal registration, malicious intent, or sanctions status.

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Policy exposure multiplier | met | 100 / 100 | no confirmed policy-scope location match |

## AI Readiness — 48/100 (At risk)

How well is the repo equipped to be developed and maintained with AI coding agents? An independent, experimental badge — weight 0.0, so it is surfaced on its own and does not affect the overall health score.

### Agent context & guidance — 1/100 (Critical)

Excluded from scoring (no data or not applicable): Legible commit history. Remaining weights renormalized.

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Agent instructions | not met | 0 / 45 | no CLAUDE.md / AGENTS.md / editor rules |
| Machine-readable docs (llms.txt) | not met | 0 / 15 | — |
| Legible commit history | excluded | 0 / 40 | no data |

### Verify loop (build / test / typecheck) — 73/100 (Good)

Excluded from scoring (no data or not applicable): Demonstrated agent practice. Remaining weights renormalized.

| Criterion | Status | Points | Detail |
|---|---|---|---|
| One-command bootstrap | met | 18 / 18 | noxfile.py |
| Automated tests | met | 22 / 22 | — |
| Lint / format config | not met | 0 / 11 | — |
| Static type checking | met | 11 / 11 | py/frequenz/api/common/py.typed |
| Reproducible environment | not met | 0 / 10 | — |
| Demonstrated agent practice | excluded | 0 / 10 | no data |
| Automated maintenance | partial | 5 / 8 | dependency automation configured, none observed in the sampled commits |
| OpenSSF Scorecard: Pinned-Dependencies | met | 10 / 10 | all dependencies are pinned |

### Code legibility for models — 82/100 (Good)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| Type-checkable code | partial | 27 / 45 | Python with type-check config (py/frequenz/api/common/py.typed) |
| Manageable file sizes | met | 55 / 55 | 0/42 source files over 60KB |

### Machine-readable interfaces — 40/100 (At risk)

| Criterion | Status | Points | Detail |
|---|---|---|---|
| API schema (OpenAPI/GraphQL/proto) | met | 40 / 40 | proto/frequenz/api/common/components.proto, proto/frequenz/api/common/location.proto, proto/frequenz/api/common/metrics.proto, proto/frequenz/api/common/metrics/electrical.proto, proto/frequenz/api/common/v1/grid/delivery_area.proto, proto/frequenz/api/common/v1/grid/delivery_duration.proto, proto/frequenz/api/common/v1/location.proto, proto/frequenz/api/common/v1/market/energy.proto, proto/frequenz/api/common/v1/market/power.proto, proto/frequenz/api/common/v1/market/price.proto, proto/frequenz/api/common/v1/metrics/bounds.proto, proto/frequenz/api/common/v1/metrics/metric_sample.proto, proto/frequenz/api/common/v1/microgrid/components/battery.proto, proto/frequenz/api/common/v1/microgrid/components/components.proto, proto/frequenz/api/common/v1/microgrid/components/ev_charger.proto, proto/frequenz/api/common/v1/microgrid/components/fuse.proto, proto/frequenz/api/common/v1/microgrid/components/grid.proto, proto/frequenz/api/common/v1/microgrid/components/inverter.proto, proto/frequenz/api/common/v1/microgrid/components/transformer.proto, proto/frequenz/api/common/v1/microgrid/lifetime.proto, proto/frequenz/api/common/v1/microgrid/microgrid.proto, proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto, proto/frequenz/api/common/v1/pagination/pagination_info.proto, proto/frequenz/api/common/v1/pagination/pagination_params.proto, proto/frequenz/api/common/v1/types/decimal.proto, proto/frequenz/api/common/v1alpha7/grid/delivery_area.proto, proto/frequenz/api/common/v1alpha7/grid/delivery_duration.proto, proto/frequenz/api/common/v1alpha7/market/energy.proto, proto/frequenz/api/common/v1alpha7/market/power.proto, proto/frequenz/api/common/v1alpha7/market/price.proto, proto/frequenz/api/common/v1alpha7/metrics/bounds.proto, proto/frequenz/api/common/v1alpha7/metrics/metrics.proto, proto/frequenz/api/common/v1alpha7/microgrid/communication_components/communication_components.proto, proto/frequenz/api/common/v1alpha7/microgrid/electrical_components/electrical_components.proto, proto/frequenz/api/common/v1alpha7/microgrid/lifetime.proto, proto/frequenz/api/common/v1alpha7/microgrid/microgrid.proto, proto/frequenz/api/common/v1alpha7/microgrid/sensors/sensors.proto, proto/frequenz/api/common/v1alpha7/pagination/pagination_info.proto, proto/frequenz/api/common/v1alpha7/pagination/pagination_params.proto, proto/frequenz/api/common/v1alpha7/streaming/event.proto, proto/frequenz/api/common/v1alpha7/type/decimal.proto, proto/frequenz/api/common/v1alpha7/type/interval.proto, proto/frequenz/api/common/v1alpha7/type/location.proto, proto/frequenz/api/common/v1alpha8/grid/balancing_group.proto, proto/frequenz/api/common/v1alpha8/grid/delivery_area.proto, proto/frequenz/api/common/v1alpha8/grid/delivery_duration.proto, proto/frequenz/api/common/v1alpha8/grid/flexibility_service.proto, proto/frequenz/api/common/v1alpha8/grid/market_location.proto, proto/frequenz/api/common/v1alpha8/grid/provision_duration.proto, proto/frequenz/api/common/v1alpha8/gridpool/gridpool.proto, proto/frequenz/api/common/v1alpha8/identity/resource_uri.proto, proto/frequenz/api/common/v1alpha8/market/energy.proto, proto/frequenz/api/common/v1alpha8/market/market_area.proto, proto/frequenz/api/common/v1alpha8/market/power.proto, proto/frequenz/api/common/v1alpha8/market/price.proto, proto/frequenz/api/common/v1alpha8/metrics/bounds.proto, proto/frequenz/api/common/v1alpha8/metrics/metrics.proto, proto/frequenz/api/common/v1alpha8/microgrid/communication_components/communication_components.proto, proto/frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto, proto/frequenz/api/common/v1alpha8/microgrid/lifetime.proto, proto/frequenz/api/common/v1alpha8/microgrid/microgrid.proto, proto/frequenz/api/common/v1alpha8/microgrid/sensors/sensors.proto, proto/frequenz/api/common/v1alpha8/pagination/pagination_info.proto, proto/frequenz/api/common/v1alpha8/pagination/pagination_params.proto, proto/frequenz/api/common/v1alpha8/streaming/event.proto, proto/frequenz/api/common/v1alpha8/types/decimal.proto, proto/frequenz/api/common/v1alpha8/types/interval.proto, proto/frequenz/api/common/v1alpha8/types/location.proto |
| MCP server | not met | 0 / 20 | — |
| Runnable examples | not met | 0 / 40 | — |

## What this report is

inspect.software measures public repositories against a single published, versioned methodology and reports the result as a 1–100 health index. Findings are signals derived from what is visible in public repository data — they are not a security audit, a warranty, or an endorsement, and no result depends on payment.

- Methodology, formulas and weights: https://inspect.software/methodology.md
- What a result does and does not claim: https://inspect.software/wiki/signals-not-warranties.md
- Rating bands: https://inspect.software/wiki/scoring-bands.md
- Corrections: https://inspect.software/contact.md
- Index of all documents: https://inspect.software/llms.txt