mikomi 0.1.0a1__tar.gz

mikomi-0.1.0a1/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+*.egg-info/
+dist/
+
+# Secrets: never committed, never read by agents (AGENTS.md).
+.env
+.env.*
+!.env.example
+
+# A local workspace used for development: `mikomi init .local` or any `*.duckdb`.
+.local/
+*.duckdb
+*.duckdb.wal
+
+# Test and UI-test output
+.coverage
+coverage/
+test-results/
+playwright-report/
+
+# The built website (website/build.py).
+website/dist/
+
+# Agents' worktrees are copies of the repository, not the repository.
+.claude/worktrees/
+
+# OS noise
+.DS_Store

mikomi-0.1.0a1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mikomi-0.1.0a1/NOTICE

@@ -0,0 +1,3 @@
+Mikomi
+
+Copyright 2026 KAITEN INC

mikomi-0.1.0a1/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.5
+Name: mikomi
+Version: 0.1.0a1
+Summary: Open-source FinOps for startups: cloud and AI costs and credits as Apache Iceberg tables, processed with DuckDB, with the provenance behind every number.
+Project-URL: Homepage, https://mikomi.dev
+Project-URL: Repository, https://github.com/kaitencloud/mikomi
+Project-URL: Issues, https://github.com/kaitencloud/mikomi/issues
+Author-email: KAITEN INC <support@kaiten.sh>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: cloud-costs,credits,duckdb,finops,focus,iceberg
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: boto3>=1.35
+Requires-Dist: duckdb>=1.4
+Requires-Dist: fastapi>=0.115
+Requires-Dist: httpx>=0.28
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: pydantic<3,>=2.11
+Requires-Dist: pyiceberg[pyarrow,pyiceberg-core,sql-sqlite]>=0.10
+Requires-Dist: uvicorn>=0.32
+Provides-Extra: databricks
+Requires-Dist: databricks-sql-connector>=4.0; extra == 'databricks'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <picture>
+    <source srcset="docs/design/brand/wordmark/mikomi-lockup-stacked-dark.svg" media="(prefers-color-scheme: dark)">
+    <img src="docs/design/brand/wordmark/mikomi-lockup-stacked-light.svg" alt="Mikomi" width="220">
+  </picture>
+</p>
+
+# Mikomi
+
+**Mikomi** (見込み, *outlook*) is an open-source FinOps tool for startups, by
+[Kaiten](https://kaiten.sh): it collects cloud and AI costs and credits, keeps them as Apache
+Iceberg tables in the [FOCUS](https://focus.finops.org) format next to a credit ledger,
+processes them with DuckDB, and shows how much runway the credits really give, with the
+provenance behind every number.
+
+> **Status: under construction, V1 in progress.** This pre-release creates a workspace, its
+> Iceberg catalog and every table, checks it (`mikomi doctor`) and queries it
+> (`mikomi query`); collecting costs and credits comes next. The first release will come with
+> its documentation at mikomi.dev. Until then this repository is where the work happens, in
+> the open.
+
+## Try it
+
+```bash
+uv sync
+uv run mikomi init demo
+cd demo && uv run mikomi doctor
+uv run mikomi query "select table_name from information_schema.tables order by 1"
+```
+
+The user documentation is in [`docs/user/en/`](docs/user/en/index.md).
+
+## Toolchain
+
+Python ≥ 3.12, [uv](https://docs.astral.sh/uv/), DuckDB for compute, Apache Iceberg
+(PyIceberg) for storage. One command, `mikomi`.
+
+## Repository
+
+| Path | What |
+|---|---|
+| `src/mikomi/` | the package: configuration, workspace, storage (catalog, tables, writer, reader), connectors, CLI |
+| `tests/` | unit, integration and CLI end-to-end tests, the docs and website tests; `tests/fixtures/tables.json` pins the tables |
+| `docs/user/` | the user documentation, held to the code by `tests/test_docs.py` |
+| `website/` | the static site of mikomi.dev: `website/build.py` builds it into `website/dist/` |
+| `examples/` | configuration, FOCUS and CSV samples, SQL mappings, manual credits — the fixtures of the test suite |
+| `docs/design/brand/` | the mascot, its states, the lock-ups, the favicons and the design tokens |
+| `AGENTS.md`, `CLAUDE.md` | standing rules for agents working here |
+
+## License
+
+Mikomi is open source and licensed under the [Apache License, Version 2.0](./LICENSE).
+
+By contributing, you agree to certify your contribution under the
+[Developer Certificate of Origin 1.1](./DCO.md).
+
+The Kaiten and Mikomi names and logos are not licensed under Apache-2.0. See the
+[Kaiten trademark policy](https://github.com/kaitencloud/kaiten/blob/main/TRADEMARKS.md).

mikomi-0.1.0a1/README.md

@@ -0,0 +1,58 @@
+<p align="center">
+  <picture>
+    <source srcset="docs/design/brand/wordmark/mikomi-lockup-stacked-dark.svg" media="(prefers-color-scheme: dark)">
+    <img src="docs/design/brand/wordmark/mikomi-lockup-stacked-light.svg" alt="Mikomi" width="220">
+  </picture>
+</p>
+
+# Mikomi
+
+**Mikomi** (見込み, *outlook*) is an open-source FinOps tool for startups, by
+[Kaiten](https://kaiten.sh): it collects cloud and AI costs and credits, keeps them as Apache
+Iceberg tables in the [FOCUS](https://focus.finops.org) format next to a credit ledger,
+processes them with DuckDB, and shows how much runway the credits really give, with the
+provenance behind every number.
+
+> **Status: under construction, V1 in progress.** This pre-release creates a workspace, its
+> Iceberg catalog and every table, checks it (`mikomi doctor`) and queries it
+> (`mikomi query`); collecting costs and credits comes next. The first release will come with
+> its documentation at mikomi.dev. Until then this repository is where the work happens, in
+> the open.
+
+## Try it
+
+```bash
+uv sync
+uv run mikomi init demo
+cd demo && uv run mikomi doctor
+uv run mikomi query "select table_name from information_schema.tables order by 1"
+```
+
+The user documentation is in [`docs/user/en/`](docs/user/en/index.md).
+
+## Toolchain
+
+Python ≥ 3.12, [uv](https://docs.astral.sh/uv/), DuckDB for compute, Apache Iceberg
+(PyIceberg) for storage. One command, `mikomi`.
+
+## Repository
+
+| Path | What |
+|---|---|
+| `src/mikomi/` | the package: configuration, workspace, storage (catalog, tables, writer, reader), connectors, CLI |
+| `tests/` | unit, integration and CLI end-to-end tests, the docs and website tests; `tests/fixtures/tables.json` pins the tables |
+| `docs/user/` | the user documentation, held to the code by `tests/test_docs.py` |
+| `website/` | the static site of mikomi.dev: `website/build.py` builds it into `website/dist/` |
+| `examples/` | configuration, FOCUS and CSV samples, SQL mappings, manual credits — the fixtures of the test suite |
+| `docs/design/brand/` | the mascot, its states, the lock-ups, the favicons and the design tokens |
+| `AGENTS.md`, `CLAUDE.md` | standing rules for agents working here |
+
+## License
+
+Mikomi is open source and licensed under the [Apache License, Version 2.0](./LICENSE).
+
+By contributing, you agree to certify your contribution under the
+[Developer Certificate of Origin 1.1](./DCO.md).
+
+The Kaiten and Mikomi names and logos are not licensed under Apache-2.0. See the
+[Kaiten trademark policy](https://github.com/kaitencloud/kaiten/blob/main/TRADEMARKS.md).

mikomi-0.1.0a1/docs/user/en/configuration.md

@@ -0,0 +1,236 @@
+# Configuration
+
+`mikomi.toml` holds the whole configuration of a workspace; every key is listed on this page, and a key that is not is an error.
+
+## The file
+
+`mikomi init` writes `mikomi.toml` with every key of the schema, the optional blocks
+commented out, so that the file is its own reference. Paths in it are relative to the
+workspace. A minimal file:
+
+```toml
+[workspace]
+name = "acme-finops"
+
+[catalog]
+type = "sql"
+```
+
+Mikomi reads the file whenever a command opens the workspace. A problem — a TOML syntax
+error, an unknown key, a missing key, a value of the wrong kind — stops the command with a
+message that names the key and, when it can, the line:
+
+```text
+mikomi: mikomi.toml, line 6: catalog.wharehouse: unknown key (did you mean warehouse?)
+```
+
+`mikomi doctor` reports the same problems as a failed `config` check.
+
+## Secrets are references
+
+A secret is never written in `mikomi.toml`. Where a key takes a secret, its value is a
+reference to an environment variable:
+
+```toml
+[[sources]]
+id = "openrouter"
+kind = "openrouter"
+api_key = { env = "OPENROUTER_MANAGEMENT_KEY" }
+```
+
+Mikomi reads the variable only when it needs the value, and replaces the value by `***`
+anywhere it could be written: logs, errors and command output. A secret written in clear
+(`api_key = "…"`) is refused, and the message does not repeat it. `mikomi doctor` says, for
+each reference, whether the variable is set.
+
+Credentials for an object store (an `s3://` warehouse) are not configured here either: they
+come from the provider's standard chain, such as AWS profiles and instance roles.
+
+## `[workspace]`
+
+| Key | Default | Meaning |
+|---|---|---|
+| `name` | required | the workspace's name, shown by the commands |
+| `timezone` | `"UTC"` | an IANA time zone, such as `"Europe/Paris"`, for displaying times; Mikomi stores every time in UTC |
+| `lookback_days` | `35` | the default window of `mikomi run`, in days |
+
+## `[catalog]`
+
+The catalog holds the Iceberg tables. [Storage](storage.md) explains the choice.
+
+| Key | Applies to | Meaning |
+|---|---|---|
+| `type` | all | `"sql"`: a local catalog in `state/catalog.sqlite`; `"rest"`: a shared Iceberg REST catalog |
+| `warehouse` | all | `sql`: a directory of the workspace (default `"warehouse"`) or an object-store URI such as `s3://bucket/prefix`; `rest`: the catalog's warehouse, on Databricks the Unity Catalog catalog |
+| `preset` | `rest` | `"databricks"`: derive the Iceberg REST endpoint and the OAuth endpoint from `host` |
+| `host` | `rest` with the preset | the Databricks workspace URL, starting with `https://` |
+| `uri` | `rest` without a preset | the catalog's REST endpoint |
+| `credential` | `rest` | a secret reference to `client_id:client_secret` of a service principal (OAuth) |
+| `token` | `rest` | a secret reference to a bearer token, such as a personal access token; not with `credential` |
+
+Unity Catalog on Databricks:
+
+```toml
+[catalog]
+type = "rest"
+preset = "databricks"
+host = "https://dbc-a1b2c3d4-e5f6.cloud.databricks.com"
+warehouse = "mikomi_dev"
+credential = { env = "DATABRICKS_CLIENT_CREDENTIAL" }
+```
+
+Any other Iceberg REST catalog:
+
+```toml
+[catalog]
+type = "rest"
+uri = "https://lakekeeper.example/catalog"
+warehouse = "finops"
+token = { env = "LAKEKEEPER_TOKEN" }
+```
+
+## `[maintenance]`
+
+| Key | Default | Meaning |
+|---|---|---|
+| `keep_days` | `30` | `mikomi maintain` expires the table snapshots older than this |
+
+## `[alerts]`
+
+| Key | Default | Meaning |
+|---|---|---|
+| `spike_ratio` | `1.3` | a cost spike is this month's cost, projected to the month's end, above last month's times this ratio; more than 1 |
+
+## `[scheduler]`
+
+Read by `mikomi serve`, which runs the collection on a schedule. With cron or a CI, run
+`mikomi run` instead.
+
+| Key | Default | Meaning |
+|---|---|---|
+| `every` | `"24h"` | the interval between runs, in hours (`"6h"`) or minutes (`"30m"`), or `"off"` |
+| `at` | `"04:00"` | the time of day of daily runs, 24-hour, in `[workspace] timezone` |
+| `export_after_run` | `false` | write the single-file extracts of `exports/` after each scheduled run |
+
+## `[serve]`
+
+| Key | Default | Meaning |
+|---|---|---|
+| `host` | `"127.0.0.1"` | the address `mikomi serve` listens on |
+| `port` | `7177` | its port |
+
+## `[[sources]]`
+
+One `[[sources]]` table per origin of data. Every source has:
+
+| Key | Default | Meaning |
+|---|---|---|
+| `id` | required | the source's name: lowercase letters, digits, `-` and `_`; unique in the file |
+| `kind` | required | `aws`, `openrouter`, `focus_file`, `csv` or `manual` |
+| `enabled` | `true` | a disabled source is kept in the file and skipped |
+
+The other keys depend on the kind. In this pre-release, `mikomi doctor` checks the `manual`
+source's file; the connectors of the other kinds are not available yet, and the doctor says
+so.
+
+### `kind = "manual"`
+
+Credits declared by hand in a TOML file.
+
+| Key | Default | Meaning |
+|---|---|---|
+| `path` | `"credits/manual.toml"` | the file of manual credits |
+
+### `kind = "aws"`
+
+| Key | Default | Meaning |
+|---|---|---|
+| `account_id` | required | the 12-digit account the Billing API is called for |
+| `payer_account` | `false` | aggregate the consolidated billing family |
+| `region` | `"us-east-1"` | the Billing API endpoint region |
+| `credentials` | the default chain | a boto3 profile name |
+
+`[sources.focus_export]`, the FOCUS Data Export on S3: `bucket`, `prefix` and
+`focus_version` (the version the export declares, such as `"1.0"`), all required when the
+table is present. `[sources.credits]`: `enabled` (default `true`).
+
+```toml
+[[sources]]
+id = "aws-main"
+kind = "aws"
+account_id = "123456789012"
+payer_account = true
+[sources.focus_export]
+bucket = "acme-billing-exports"
+prefix = "focus/acme-focus-export"
+focus_version = "1.0"
+[sources.credits]
+enabled = true
+```
+
+### `kind = "openrouter"`
+
+| Key | Default | Meaning |
+|---|---|---|
+| `api_key` | required | a secret reference to an OpenRouter management key |
+
+### `kind = "focus_file"`
+
+A FOCUS file from a provider without a connector, imported as is.
+
+| Key | Default | Meaning |
+|---|---|---|
+| `path` | required | a CSV, gzip CSV or Parquet file, a glob, or an `s3://` URI |
+| `focus_version` | required | the FOCUS version the file declares: `"1.0"`, `"1.2"`, `"1.3"` or `"1.4"` |
+| `provider` | none | the provider's name, for display |
+
+### `kind = "csv"`
+
+A proprietary CSV file mapped with SQL: one `SELECT` per destination table.
+
+| Key | Default | Meaning |
+|---|---|---|
+| `provider` | required | the provider's name, stored on every row |
+| `path` | required | the file, or a glob |
+
+`[sources.csv]`, how to read the file:
+
+| Key | Default | Meaning |
+|---|---|---|
+| `delimiter` | `","` | one character |
+| `header` | `true` | the first line names the columns |
+| `encoding` | `"utf-8"` | `"utf-8"`, `"utf-8-sig"` or `"latin-1"` |
+| `decimal_separator` | `"."` | `"."` or `","` |
+| `timezone` | `"UTC"` | the time zone of timestamps written without one |
+| `null_values` | `["", "NULL"]` | the texts read as no value |
+
+`[[sources.mappings]]`, one per destination:
+
+| Key | Default | Meaning |
+|---|---|---|
+| `destination` | required | `focus`, `staging.non_focus_costs`, `credits.grants`, `credits.pools`, `credits.balance_snapshots`, `credits.allocations` or `credits.events` |
+| `sql` | required | the file of the mapping's `SELECT` |
+| `focus_version` | `"1.4"` | the FOCUS version of a `focus` mapping; only for that destination |
+
+`[sources.import]`: `on_error`, `"quarantine"` (default: publish the valid rows, keep the
+others aside) or `"strict"` (publish nothing of the source when a row is refused).
+
+## The workspace directory
+
+| Path | What |
+|---|---|
+| `mikomi.toml` | this configuration |
+| `warehouse/` | the tables, with a local catalog whose warehouse is a directory |
+| `raw/` | every artifact fetched or read, kept unchanged: `raw/<source_id>/<YYYY-MM-DD>/<sha256>-<name>` |
+| `mappings/` | the SQL mappings of CSV sources |
+| `credits/` | the files of manual credits |
+| `exports/` | single-file extracts |
+| `state/` | `catalog.sqlite` (local catalog), `mikomi.lock`, `mikomi.log` |
+
+`raw/`, `warehouse/`, `state/` and `exports/` hold account ids, resource ids, tags and the
+data: the `.gitignore` that `mikomi init` writes keeps them out of version control.
+
+## Related
+
+- [Storage](storage.md)
+- [Your first workspace](getting-started.md)