Skip to content

1063 usethis badge socket #1080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 3 commits into from
Nov 5, 2025
Merged

1063 usethis badge socket #1080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d49b846
Add Socket badge implementation
nathanjmcdougall Nov 4, 2025
a907957
Add the socket badge to the README
nathanjmcdougall Nov 4, 2025
067e484
Merge branch 'main' into 1063-usethis-badge-socket
nathanjmcdougall Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ If you're not interested in templating automations, then [configurator](https://
[![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/usethis-python/usethis-python)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Socket Badge](https://badge.socket.dev/pypi/package/usethis)](https://socket.dev/pypi/package/usethis/overview)

### Roadmap

Expand Down
12 changes: 12 additions & 0 deletions src/usethis/_core/badge.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ def get_ruff_badge() -> Badge:
)


def get_socket_badge() -> Badge:
name = get_project_name()
return Badge(
markdown=f"[![Socket Badge](https://badge.socket.dev/pypi/package/{name})](https://socket.dev/pypi/package/{name}/overview)"
)


def get_uv_badge() -> Badge:
return Badge(
markdown="[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)"
Expand All @@ -68,12 +75,17 @@ def get_usethis_badge() -> Badge:


def get_badge_order() -> list[Badge]:
# Some general principles here:
# 1. Dynamic badges giving factual information about the package should go first
# 2. Static badges which list affiliation should go next e.g. uv, Ruff, etc.
# 3. Badges giving project scores, ratings, etc. should go last.
return [
get_pypi_badge(),
get_uv_badge(),
get_ruff_badge(),
get_pre_commit_badge(),
get_usethis_badge(),
get_socket_badge(),
]


Expand Down
17 changes: 17 additions & 0 deletions src/usethis/_ui/interface/badge.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,23 @@ def pre_commit(
_badge_effect(get_pre_commit_badge(), remove=remove, show=show)


@app.command(
help="Add a badge with your PyPI package's supply chain security rating from Socket."
)
def socket(
remove: bool = remove_opt,
offline: bool = offline_opt,
quiet: bool = quiet_opt,
show: bool = show_opt,
) -> None:
from usethis._config import usethis_config
from usethis._config_file import files_manager
from usethis._core.badge import get_socket_badge

with usethis_config.set(offline=offline, quiet=quiet), files_manager():
_badge_effect(get_socket_badge(), remove=remove, show=show)


@app.command(help="Add a badge for usethis.")
def usethis(
remove: bool = remove_opt,
Expand Down
11 changes: 11 additions & 0 deletions tests/usethis/_ui/interface/test_interface_badge.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,17 @@ def test_show(self, tmp_path: Path):
assert result.exit_code == 0, result.output


class TestSocket:
def test_add(self, tmp_path: Path):
# Act
runner = CliRunner()
with change_cwd(tmp_path):
result = runner.invoke_safe(app, ["socket"])

# Assert
assert result.exit_code == 0, result.output


class TestPreCommit:
def test_add(self, tmp_path: Path):
# Act
Expand Down