feat: add multilingual support so Naomi can use Python too

2026-01-23 15:32:02 -08:00
parent 38e7f15d93
commit c0ad74367a
52 changed files with 1305 additions and 46 deletions
@@ -1,20 +1,132 @@
-# New Repository Template
+# Ephemere

-This template contains all of our basic files for a new GitHub repository. There is also a handy workflow that will create an issue on a new repository made from this template, with a checklist for the steps we usually take in setting up a new repository.
+A collection of ephemeral scripts for various tasks, written in TypeScript and Python.

-If you're starting a Node.JS project with TypeScript, we have a [specific template](https://github.com/naomi-lgbt/nodejs-typescript-template) for that purpose.
+## Project Structure

-## Readme
+```
+.
+├── typescript/     # TypeScript project
+│   ├── src/       # TypeScript source files
+│   ├── package.json
+│   ├── tsconfig.json
+│   └── eslint.config.js
+├── python/        # Python project
+│   ├── *.py       # Python scripts
+│   ├── pyproject.toml
+│   └── requirements.txt
+├── Makefile       # Build commands for both projects
+└── README.md
+```

-Delete all of the above text (including this line), and uncomment the below text to use our standard readme template.
+## Setup

-<!-- # Project Name
+### Prerequisites

-Project Description
+- Node.js (v24+) with nvm
+- Python 3.10+
+- pnpm 10.15.0
+- uv (Python package manager)
+- 1Password CLI (for secrets management)

-## Live Version
+### Installation

-This page is currently deployed. [View the live website.]
+Install all dependencies (TypeScript and Python):
+```bash
+make install
+```
+
+Or install individually:
+```bash
+make install-ts  # TypeScript dependencies only
+make install-py  # Python dependencies only
+```
+
+## Development
+
+### TypeScript Scripts
+
+TypeScript scripts are located in the `typescript/src/` directory. To run a TypeScript script with environment variables:
+
+```bash
+# From the root directory
+make run-ts src/s3/upload.ts
+
+# Or manually from typescript directory
+cd typescript
+pnpm start path/to/script.ts
+```
+
+### Python Scripts
+
+Python scripts are located in the `python/` directory. To run a Python script with environment variables:
+
+```bash
+# From the root directory
+make run-py analyse_availability.py
+
+# Or manually from python directory
+cd python
+uv run python script_name.py
+```
+
+## Linting and Formatting
+
+```bash
+# Run all linters (TypeScript and Python)
+make lint
+
+# Run linters individually
+make lint-ts     # TypeScript linter
+make lint-py     # Python linter
+
+# Build TypeScript (type check)
+make build
+
+# Format Python code
+make format
+
+# Check Python formatting without modifying
+make format-check
+
+# Run tests
+make test
+
+# Clean build artifacts and caches
+make clean
+
+# Show all available commands
+make help
+```
+
+## CI/CD
+
+The GitHub Actions workflow runs the following checks:
+
+1. **Dependency pin check** - Ensures all dependencies are pinned to exact versions
+2. **TypeScript checks**:
+   - ESLint
+   - TypeScript build (type checking)
+   - Tests
+3. **Python checks**:
+   - Ruff linting
+   - Ruff format checking
+
+## Secrets Management
+
+This project uses 1Password CLI for secrets management. Environment variables are stored in `prod.env` as 1Password vault references.
+
+The `make run-ts` and `make run-py` commands automatically inject secrets from 1Password:
+```bash
+# These commands include 1Password integration
+make run-ts src/discord/bot.ts
+make run-py evaluate_technical_proficiency.py
+```
+
+To manually run scripts with secrets:
+```bash
+op run --env-file=prod.env -- <command>
+```

 ## Feedback and Bugs

@@ -36,4 +148,4 @@ Copyright held by Naomi Carrigan.

 ## Contact

-We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`. -->
+We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`.