Skip to content

Foundation: project scaffolding and Python package skeleton #61

Closed

Description

@CompleteDotTech

Goal

Give the repository a working Python project so every later issue has somewhere to put code and a way to test it.

Scope

  • pyproject.toml for a package named jev_cookbook under src/, Python 3.10 or newer (the floor of typesafe-sdk).
  • Core dependencies kept small: numpy, matplotlib, jupyter/nbclient for execution. Optional extras: live (typesafe-sdk), ml (scikit-learn), dev (ruff, pytest).
  • ruff configured for lint and format, including notebooks. pytest configured with --import-mode=importlib so recipe folders can carry their own tests/.
  • A README section or docs/development.md with the three commands a contributor needs: install, lint, test.
  • A trivial test that imports the package, so CI has something to run.

Acceptance criteria

  • pip install -e ".[dev]" works in a clean virtual environment on Linux and Windows
  • ruff check ., ruff format --check ., and pytest all pass
  • No dependency requires a network call or API key at import time
  • Dependency policy (what goes in core and what goes in an extra) is written down
  • Lint and tests pass in CI, or locally with the output pasted in the pull request if CI does not exist yet

Dependencies

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: p0Blocks everything else; do firstsize: SAbout half a day for one agent or persontype: foundationShared code, tooling, CI, or docs that recipes depend on

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions