Skip to content

About

Installable Search module for the Open City Planner

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

8 Commits

Folders and files

Repository files navigation

ocp-module-search

Installable Search module for the Open City Planner. It will eventually own the Search and Intelligent Search functionality removed from the Slim Host.

Status: bootstrap / pre-functional. Version 0.1.0 proves packaging, discovery, and lifecycle integration. It does not implement production search.

Surfaces

  • ocp-module-search: Python package with an SDK ModuleDefinition and a small /api/v1/search/module-info installation-readiness endpoint.
  • @open-city-planner/search: discoverable neutral Nuxt layer with no public contributions. There is deliberately no Search UI.
  • search-0.1.0.ocp: reproducible bundle containing both packages and the manifest.

There are no database models, migrations, domain SQL, notification extensions, or private Host imports.

Development

cd backend
uv sync --frozen --extra dev
uv run ruff check src tests
uv run pytest
uv build --wheel

cd ../frontend
pnpm install --frozen-lockfile
pnpm typecheck
pnpm test
pnpm build

cd ..
OCP_HOST_CHECKOUT=/path/to/open-city-planner scripts/build-bundle
sha256sum -c dist/search-0.1.0.ocp.sha256
OCP_HOST_CHECKOUT=/path/to/open-city-planner scripts/host-contract-test

Follow-up

Characterize the historical Host Search implementation before functional migration. Provider contracts and Intelligent Search will be designed in later issues from real consumer requirements, rather than being invented as a generic mega-API.

The completed Phase 1 evidence is documented in Historical Search Characterization and the accompanying Search Dependency Matrix.

About

Installable Search module for the Open City Planner

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages