Skip to content

docs: integrate Typer and Click#619

Merged
jdx merged 1 commit intojdx:mainfrom
gaojunran:docs-integrate-python
May 3, 2026
Merged

docs: integrate Typer and Click#619
jdx merged 1 commit intojdx:mainfrom
gaojunran:docs-integrate-python

Conversation

@gaojunran
Copy link
Copy Markdown
Contributor

@codecov
Copy link
Copy Markdown

codecov Bot commented May 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.03%. Comparing base (f9ea78b) to head (fc2be14).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #619   +/-   ##
=======================================
  Coverage   79.03%   79.03%           
=======================================
  Files          48       48           
  Lines        7235     7235           
  Branches     7235     7235           
=======================================
  Hits         5718     5718           
  Misses       1140     1140           
  Partials      377      377           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 3, 2026

Greptile Summary

This PR promotes the Typer and Click Python integrations from "Planned" to "Available" in the integrations docs, adding links to their PyPI packages (usage-spec-typer and usage-spec-click) in both the integrations table and the VitePress sidebar nav. The changes are consistent with the existing patterns for externally-hosted integrations.

Confidence Score: 5/5

Safe to merge — documentation-only change with no logic or runtime impact.

No code logic is changed. Both files follow existing patterns exactly. The table formatting, external links, and sidebar entries are all consistent with prior integrations.

No files require special attention.

Important Files Changed

Filename Overview
docs/spec/integrations.md Moves Typer and Click from the "Planned" section to the "Available" integrations table with PyPI package links; consistent with existing entries.
docs/.vitepress/config.mts Adds sidebar nav entries for Typer and Click (Python) pointing to their PyPI packages; follows the same pattern as existing external-link entries.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[integrations.md - Planned] -->|Promoted| B[integrations.md - Available]
    B --> C[Typer - usage-spec-typer on PyPI]
    B --> D[Click - usage-spec-click on PyPI]
    E[config.mts sidebar nav] --> C
    E --> D
Loading

Reviews (1): Last reviewed commit: "docs: integrate Typer and Click" | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds Typer and Click Python integrations to the documentation sidebar and the integrations table, while removing them from the planned section. The reviewer suggests grouping these new Python entries with existing ones to improve readability and removing trailing slashes from the PyPI URLs for consistency across the documentation.

Comment on lines +98 to +99
{ text: "Typer (Python)", link: "https://pypi.org/project/usage-spec-typer/" },
{ text: "Click (Python)", link: "https://pypi.org/project/usage-spec-click/" },
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Consider grouping the Python integrations together in the sidebar for better readability. Currently, Typer and Click are added at the end of the list, while argparse is located at line 93. Moving these entries to follow argparse would make the list easier to navigate by language.

Additionally, the trailing slashes in the PyPI URLs have been removed in the suggestion below to maintain consistency with other external links in the sidebar.

              { text: "Typer (Python)", link: "https://pypi.org/project/usage-spec-typer" },
              { text: "Click (Python)", link: "https://pypi.org/project/usage-spec-click" },

Comment thread docs/spec/integrations.md
Comment on lines +16 to +17
| [Typer](https://github.com/fastapi/typer) | Python | [`usage-spec-typer`](https://pypi.org/project/usage-spec-typer/) |
| [Click](https://github.com/pallets/click) | Python | [`usage-spec-click`](https://pypi.org/project/usage-spec-click/) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Consider grouping the Python integrations together in the 'Available' table. Moving the Typer and Click entries to follow the argparse entry (line 11) would improve the organization of the table by language, making it more consistent and easier to scan.

Additionally, the trailing slashes in the PyPI URLs have been removed in the suggestion below to match the format used for other external links in this table.

Suggested change
| [Typer](https://github.com/fastapi/typer) | Python | [`usage-spec-typer`](https://pypi.org/project/usage-spec-typer/) |
| [Click](https://github.com/pallets/click) | Python | [`usage-spec-click`](https://pypi.org/project/usage-spec-click/) |
| [Typer](https://github.com/fastapi/typer) | Python | [`usage-spec-typer`](https://pypi.org/project/usage-spec-typer) |
| [Click](https://github.com/pallets/click) | Python | [`usage-spec-click`](https://pypi.org/project/usage-spec-click) |

@jdx jdx merged commit 7f29f3c into jdx:main May 3, 2026
9 checks passed
@mise-en-dev mise-en-dev mentioned this pull request May 3, 2026
jdx pushed a commit that referenced this pull request May 3, 2026
### 🚀 Features

- **(complete)** auto-completion for usage shebang scripts by
[@jdx](https://github.com/jdx) in
[#620](#620)

### 🐛 Bug Fixes

- **(docs)** stack banner and pin close button on mobile by
[@jdx](https://github.com/jdx) in
[#603](#603)

### 📚 Documentation

- **(site)** show release version and github stars by
[@jdx](https://github.com/jdx) in
[#604](#604)
- add cross-site announcement banner by [@jdx](https://github.com/jdx)
in [#600](#600)
- fix banner dark-mode contrast by [@jdx](https://github.com/jdx) in
[#601](#601)
- respect banner expires field by [@jdx](https://github.com/jdx) in
[#602](#602)
- prefix star count with ★ glyph and populate it on deploy by
[@jdx](https://github.com/jdx) in
[#606](#606)
- integrate Commander.js, oclif and yargs by
[@gaojunran](https://github.com/gaojunran) in
[#616](#616)
- integrate Typer and Click by
[@gaojunran](https://github.com/gaojunran) in
[#619](#619)

### 🔍 Other Changes

- **(docs)** remove shrill.en.dev analytics script by
[@jdx](https://github.com/jdx) in
[#614](#614)
- **(release)** append en.dev sponsor blurb to release notes by
[@jdx](https://github.com/jdx) in
[#598](#598)
- switch analytics from gtm to plausible by
[@jdx](https://github.com/jdx) in
[#609](#609)
- pin taiki-e/install-action to commit SHA by
[@jdx](https://github.com/jdx) in
[#610](#610)
- rename CLAUDE.md to AGENTS.md and symlink by
[@jdx](https://github.com/jdx) in
[#618](#618)

### 📦️ Dependency Updates

- bump communique to 1.1.2 by [@jdx](https://github.com/jdx) in
[#605](#605)
- lock file maintenance by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#607](#607)
- update autofix-ci/action action to v1.3.4 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#611](#611)
- update apple-actions/import-codesign-certs action to v7 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#612](#612)
- update taiki-e/install-action digest to fc9eae0 by
[@renovate[bot]](https://github.com/renovate[bot]) in
[#613](#613)

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants