hyundai-kia-connect/hyundai_kia_connect_api

0

/ 100

Documentation64
Engineering99
Health100
Python337MIT1d ago
Grade a repo

Polished and well engineered. Punching above its star count.

This is a Kia UVO and Hyundai Bluelink written in python. It is primary consumed by home assistant. If you are looking for a home assistant Kia / Hyundai implementation please look here: https://github.com/Hyundai-Kia-Connect/kia_uvo. Much of this base code came from reading bluelinky and contributions to the kia_uvo home assistant project.

Documentation

64

README12pt40

README is present.

Install and run instructions9pt55

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt95

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

99

Reproducibility6pt90

Lockfile present (requirements.txt). Installs are reproducible.

Tests18pt100

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/lintPR.yaml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 195
    Forks
  • 561
    Releaseslatest 4y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 337
    Watchers

Responsiveness

  • 3h
    Median issue response
  • <1h
    Median PR merge time
  • 22
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/lintPR.yaml).
    Good: Dependabot covers 2 ecosystems (pip, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • .vscode
  • docs
  • hyundai_kia_connect_api
  • scripts
  • tests
    Good: Test files detected (tests).
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • AUTHORS.rst
  • CANADA_LOGIN_FLOW_WITH_OTP.md
  • CONTRIBUTING.rst
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • HISTORY.rst
  • LICENSE
    Good: Licensed under MIT.
  • Makefile
  • MANIFEST.in
  • OTP_RMTOKEN_IMPLEMENTATION.md
  • README.rst
    Good: README is present.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).
  • setup.cfg
  • setup.py