diff --git a/README.md b/README.md new file mode 100644 index 0000000..f618b8a --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# roledesk + +A job-search engine for one person. It reads the public job boards of the companies you follow (Greenhouse, Lever, Ashby, Workable, SmartRecruiters, Recruitee, Personio), keeps every posting with when it was first seen and when it closed, scores the open roles for each of your search agents, and tracks the applications you make. + +Built on the [boilerplate](../boilerplate): its job queue and scheduler (`pipeline/`), password (`auth/`) and deploy kit (`deploy/`), plus the plugin contract and tools from news (`desk/`). FastAPI, Jinja2, SQLite, `uv`, no build step. + +## Quick start + +```bash +uv sync --all-extras +uv run app companies seed # 186 companies from seed/companies.json, one board each +uv run app job pull # read every board, then extract, embed and score +uv run app serve # http://127.0.0.1:8790 +``` + +`uv run app worker` drains the queue without the web app, and `uv run pytest` runs the app's tests and the copied modules' own. `config.yaml` is the committed default, with two starter search agents; `config.example.yaml` documents every key. The `embeddings` extra is what `fit` needs, `agent` is for `extract` on a model, `passkeys` for the Account tab's passkeys. + +## The tabs + +| | | +|---|---| +| **Roles** | open roles, newest or ordered by one agent's score, with filters, a Save button and each company's affinity | +| **Applications** | the saved roles and their status, each change recorded as an event | +| **Agents** | the search agents: intent, require and prefer gates, weights. Saving one rescores it | +| **Companies** | every company whose board is read, its open roles, and its affinity: mute, neutral, like, favourite | +| **Jobs** | a button per job (`pull`, `extract`, `embed`, `score`) and what is running | +| **Schedules** | `pull` every 6h by default, editable in place | +| **Messages** | everything the server said that nobody has cleared | +| **Account** | the password, sessions and passkeys. Open on loopback, locked on anything else | + +## Docs + +- [`docs/decisions.md`](docs/decisions.md): what was decided for roledesk and why. +- [`desk/README.md`](desk/README.md), [`pipeline/README.md`](pipeline/README.md), [`auth/README.md`](auth/README.md), [`deploy/README.md`](deploy/README.md): the copied modules, where each comes from and how to refresh it. +- [`docs/hosting.md`](docs/hosting.md), [`docs/release.md`](docs/release.md), [`docs/server.md`](docs/server.md), [`docs/password-protection.md`](docs/password-protection.md), [`docs/llm-backends.md`](docs/llm-backends.md): the boilerplate's deployment docs. diff --git a/pyproject.toml b/pyproject.toml index ee3a65d..08b71b6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,6 +2,7 @@ name = "roledesk" version = "0.1.0" description = "A job-search engine: ATS boards in, roles scored per search agent, applications tracked." +readme = "README.md" requires-python = ">=3.14" # The boilerplate's core, plus what `desk` and the `ats` plugin import at # module level. The package is `app` whatever this distribution is called: