generated from nhcarrigan/template
hikari
ec58c9c843
CI / dependency-pin-check-typescript (push) Successful in 5s
CI / dependency-pin-check-python (push) Successful in 4s
CI / python (push) Successful in 9m28s
CI / typescript (push) Successful in 9m42s
Security Scan and Upload / Security & DefectDojo Upload (push) Successful in 1m39s
## Summary This PR completes the bash script restructuring and adds comprehensive documentation across all script categories. ### Bash Restructuring - Moved cohort shell scripts (`remove_github_members.sh`, `update_github_teams.sh`) from `python/cohort/` into a new `bash/cohort/` directory - Moved existing bash utilities (`add-keys-to-git.sh`, `fix-yubikey-perms.sh`, `list-yubikey-ssh-keys.sh`) into a new `bash/yubikey/` subdirectory - Updated `run.sh` to support **Bash** as a third language option alongside TypeScript and Python - Bash scripts are run directly (no 1Password secret injection needed) - Category discovery and script listing works the same as for TS/Python - Removed dead "Root Scripts" logic that was no longer needed ### Documentation Added `README.md` files for all script categories that were missing them: - `bash/cohort/README.md` — cohort GitHub team management scripts - `bash/yubikey/README.md` — YubiKey SSH key and permission utilities - `typescript/src/crowdin/README.md` — Crowdin translation management scripts - `typescript/src/discord/README.md` — Discord bot utility scripts - `typescript/src/discourse/README.md` — Discourse forum management scripts - `typescript/src/gitea/README.md` — Gitea bulk repository operation scripts - `typescript/src/github/README.md` — GitHub API interaction scripts - `typescript/src/music/README.md` — Music file metadata tools - `typescript/src/s3/README.md` — S3-compatible object storage scripts - `typescript/src/security/README.md` — Security analysis and reporting scripts - `python/cohort/README.md` — Updated to remove moved shell scripts, fix usage commands Also updated project-level docs: - **`README.md`** — Corrected project structure, fixed running instructions (removed references to non-existent `make run-ts`/`make run-py` targets), added Bash prerequisites - **`CLAUDE.md`** — Updated project overview, structure, development standards, and script-adding guides to reflect the current state of the project ✨ This PR was created with help from Hikari~ 🌸 Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com> Reviewed-on: #6 Co-authored-by: Hikari <hikari@nhcarrigan.com> Co-committed-by: Hikari <hikari@nhcarrigan.com>
96 lines
2.0 KiB
TOML
96 lines
2.0 KiB
TOML
[project]
|
|
name = "ephemere"
|
|
version = "1.0.0"
|
|
description = "Collection of ephemeral scripts"
|
|
authors = [
|
|
{ name = "Naomi Carrigan", email = "nhcarrigan@gmail.com" }
|
|
]
|
|
readme = "README.md"
|
|
requires-python = ">=3.10"
|
|
dependencies = []
|
|
|
|
[project.optional-dependencies]
|
|
dev = [
|
|
"ruff==0.14.14"
|
|
]
|
|
|
|
[tool.ruff]
|
|
target-version = "py310"
|
|
line-length = 88
|
|
indent-width = 4
|
|
|
|
[tool.ruff.lint]
|
|
select = [
|
|
# pycodestyle
|
|
"E",
|
|
# pyflakes
|
|
"F",
|
|
# isort
|
|
"I",
|
|
# pydocstyle
|
|
"D",
|
|
# pyupgrade
|
|
"UP",
|
|
# flake8-bugbear
|
|
"B",
|
|
# flake8-comprehensions
|
|
"C4",
|
|
# flake8-datetimez
|
|
"DTZ",
|
|
# flake8-implicit-str-concat
|
|
"ISC",
|
|
# flake8-logging-format
|
|
"G",
|
|
# flake8-print
|
|
"T20",
|
|
# flake8-pytest-style
|
|
"PT",
|
|
# flake8-quotes
|
|
"Q",
|
|
# flake8-simplify
|
|
"SIM",
|
|
# flake8-tidy-imports
|
|
"TID",
|
|
# pylint
|
|
"PL",
|
|
]
|
|
ignore = [
|
|
# Missing docstrings
|
|
"D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107",
|
|
# Allow print statements in scripts
|
|
"T201",
|
|
# Docstring punctuation - not critical for scripts
|
|
"D415",
|
|
# Magic values - acceptable in simple scripts
|
|
"PLR2004",
|
|
# Loop variable overwritten - common pattern
|
|
"PLW2901",
|
|
# Use sys.exit instead of exit - not critical
|
|
"PLR1722",
|
|
# Collapsible if statements - readability preference
|
|
"PLR5501",
|
|
# zip strict - not critical for scripts
|
|
"B905",
|
|
# Docstring summary line spacing - not critical
|
|
"D205",
|
|
# Function complexity - acceptable for scripts
|
|
"PLR0912", "PLR0915",
|
|
# Datetime timezone - scripts use local context
|
|
"DTZ001",
|
|
# Ambiguous variable names - context makes it clear
|
|
"E741",
|
|
# Long lines in string literals (Discord messages, URLs)
|
|
"E501",
|
|
]
|
|
|
|
[tool.ruff.lint.pydocstyle]
|
|
convention = "google"
|
|
|
|
[tool.ruff.lint.isort]
|
|
known-first-party = ["py"]
|
|
|
|
[tool.ruff.format]
|
|
quote-style = "double"
|
|
indent-style = "space"
|
|
skip-magic-trailing-comma = false
|
|
line-ending = "auto" |