tonym/spoolman2
1
0
Fork 0
Code Issues 19 Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
2075f36838daa4eeafa8a1159a7f06850976259d
spoolman2/codex.md
tonym 671d3bd3d1
Some checks failed
CI / style (push) Has been cancelled
Details
CI / build-client (push) Has been cancelled
Details
CI / build-amd64 (push) Has been cancelled
Details
CI / build-tester (push) Has been cancelled
Details
CI / test (cockroachdb) (push) Has been cancelled
Details
CI / test (mariadb) (push) Has been cancelled
Details
CI / test (postgres) (push) Has been cancelled
Details
CI / test (sqlite) (push) Has been cancelled
Details
CI / build-arm64 (push) Has been cancelled
Details
CI / build-armv7 (push) Has been cancelled
Details
CI / publish-images (push) Has been cancelled
Details
CI / publish-release (push) Has been cancelled
Details
feat: Add 3dfilamentprofiles.com integration (Issue #7) 
- Backend: Added ExternalSource enum, Filament3DFP model, and transform function
- Backend: Updated _sync() to fetch from both SpoolmanDB and 3dfilamentprofiles
- Frontend: Added source tabs to FilamentImportModal (All/SpoolmanDB/3DFP)
- Frontend: Updated ExternalFilament interface with source and temp range fields
- Frontend: Updated filament import handler to use temp range fields

Also includes:
- Dev mode styling (teal theme, DEV badge and banner)
- Translation keys for source filtering

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-14 21:03:25 -06:00

2.4 KiB
Raw Blame History

Repository Guidelines

Project Structure & Module Organization

  • spoolman/ holds the FastAPI backend, SQLAlchemy models, and API routes (spoolman/api/v1/).
  • client/ is the React + TypeScript UI (Vite), with pages under client/src/pages/ and shared components under client/src/components/.
  • migrations/ contains Alembic migrations; versions live in migrations/versions/.
  • tests_integration/ holds pytest integration tests and Docker Compose configs for multiple databases.
  • scripts/ provides install/start helpers; Dockerfile and entrypoint.sh support container builds.

Build, Test, and Development Commands

  • pdm install installs backend dependencies (including dev tools).
  • pdm run app starts the API server (uvicorn spoolman.main:app).
  • pdm run itest runs integration tests across all databases.
  • pdm run docs generates API documentation.
  • python tests_integration/run.py sqlite postgres runs tests for selected DBs.
  • cd client && npm ci installs UI deps; npm run dev starts the UI dev server; npm run build creates a production build.
  • bash scripts/install.sh bootstraps a local install; bash scripts/start.sh runs using .env.

Coding Style & Naming Conventions

  • Python: Black + Ruff, 120-char lines (pyproject.toml). Prefer async patterns in backend code.
  • TypeScript/React: follow existing conventions (pages in lowercase file names, shared components in PascalCase).
  • Keep naming aligned with existing modules (e.g., spool, filament, vendor).

Testing Guidelines

  • Tests use pytest with async support; files follow test_*.py and functions start with test_.
  • Integration tests are the primary suite; run via pdm run itest or python tests_integration/run.py.

Database Migrations

  • Update models in spoolman/database/models.py.
  • Start the server once, then generate a migration: pdm run alembic revision -m "desc" --autogenerate.
  • Review and format migrations with Black/Ruff before committing.

Commit & Pull Request Guidelines

  • Follow commit history conventions (e.g., feat:, docs:, fix:) and keep messages concise.
  • PRs should include a short summary, testing performed, and screenshots for UI changes.
  • Link relevant issues where applicable.

Configuration Tips

  • Copy .env.example to .env for local runs; key variables include SPOOLMAN_DB_TYPE, SPOOLMAN_PORT, and VITE_APIURL.