arrow-py/arrowNew scan
81/ 100 ยท B

Good community traction and solid fundamentals. Nearly in the top tier.

๐Ÿน Better dates & times for Python

Python9,045 starsApache-2.0updated 9d ago
DocumentationREADME, setup, examples, license
70
EngineeringTests, CI, linting, lockfiles
81
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  2. 2
    README
    DocumentationWarning

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  3. 3
    README
    DocumentationInfo

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

Detailed breakdown

Documentation

70
  • README40
    • README is present.
    • README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    • No screenshots or images in the README (โˆ’20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has no code examples (โˆ’15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • README links to a live demo or deployed app.
    • No status badges in the README (โˆ’10 pts).Add CI/build status badges from shields.io or your CI provider to signal project health.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide70
    • CONTRIBUTING guide or docs directory present.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

81
  • Tests85
    • Test files detected (tests).
    • Pytest referenced in pyproject.toml and test files present.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/continuous_integration.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • CI reports or uploads test coverage.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
  • Linting and formatting0
    • No linter or type checker configured in pyproject.toml (โˆ’80 pts).Add [tool.ruff] for linting and [tool.mypy] for type checking to pyproject.toml.
    • No linter or formatter config found.Add ESLint, Prettier, Ruff, or similar. Consistent style lowers the barrier for contributors.
  • Reproducibility82
    • Lockfile present (requirements/requirements.txt). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • Dependabot configured for github-actions.
    • Dependabot only covers one ecosystem (+12 pts; covering 2+ earns +20 pts).Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (pyproject.toml).
    • pyproject.toml has a [project] table with package metadata.
    • pyproject.toml includes a description.
    • pyproject.toml specifies requires-python, preventing installs on incompatible versions.
    • pyproject.toml has a [build-system] table. The package can be built and published.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Python.
    • pyproject.toml [project] metadata is complete (description, authors, urls).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 9,045 stars.
  • Housekeeping100
    • .gitignore present.
Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/continuous_integration.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • arrow
  • docs
  • requirements
    Good: Lockfile present (requirements/requirements.txt). Installs are reproducible.
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yaml
  • CHANGELOG.rst
    Good: CONTRIBUTING guide or docs directory present.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.rst
    Good: README is present.
    Info: README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Warning: 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.
    Info: 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.
    Info: 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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • setup.cfg
  • tox.ini