celerp 2.5.0__tar.gz → 2.5.3__tar.gz

celerp-2.5.3/CONTRIBUTING.md

@@ -0,0 +1,190 @@
+# Contributing to Celerp
+
+Issues and PRs welcome. This guide covers the development workflow.
+
+## Contribution terms
+
+Celerp is multi-licensed (see `LICENSING.md`). What the public *receives* depends on the component
+(BUSL-1.1 core, MIT modules, proprietary layer). What you *grant us* when contributing is governed as
+follows:
+
+- **Anything accepted into an official Celerp repository** - including the MIT modules - requires a signed
+  **Contributor License Agreement** (`CLA.md`). The module stays MIT for everyone downstream; the CLA only
+  governs the rights you grant Celerp (so we can keep multi-licensing, move code between layers, and offer
+  commercial terms). Open an issue before substantial work and we will arrange signing.
+- **Third-party modules you do not submit upstream** (e.g. your own marketplace modules) need no CLA - a
+  Developer Certificate of Origin sign-off (`git commit -s`) is sufficient for those. The MIT modules are
+  the recommended starting point: fork one, rename it (see `legal/TRADEMARK.md`), and license your derivative
+  however you wish.
+
+**How CLA acceptance works.** Contributions to official Celerp repositories require a one-time CLA
+acceptance per user. If you haven't accepted yet, you'll be linked to a page that shows the agreement and
+records your acceptance so that we know that you've read our rules and expectations. After that you can
+contribute freely.
+
+Trademarks are not licensed by any code license; see `legal/TRADEMARK.md`.
+
+## Environment variables
+
+| Variable | Default | Notes |
+|----------|---------|-------|
+| `DATABASE_URL` | _(required)_ | `postgresql+asyncpg://user:pass@localhost:5432/dbname` |
+| `JWT_SECRET` | _(required)_ | Fatal on startup if unset or default in production |
+| `ALLOW_INSECURE_JWT` | `false` | Set `true` in dev/CI |
+| `CELERP_PUBLIC_URL` | _(optional)_ | Base URL for share links |
+| `MODULE_DIR` | `default_modules` | Module package directory |
+| `ENABLED_MODULES` | _(all)_ | Comma-separated list to load |
+
+## CLI commands (pip install)
+
+```bash
+celerp init             # first-time setup: DB + migrations + config, then launches the servers
+celerp init --no-start  # same setup, but exit WITHOUT launching (service-managed/headless)
+celerp start            # launch API + UI (e.g. from systemd, after `init --no-start`)
+celerp migrate    # apply pending migrations after an upgrade
+celerp status     # show config, DB connection, migration state
+celerp demo       # seed demo data
+celerp upgrade    # pip install --upgrade celerp + migrate
+```
+
+### Init flags
+
+| Flag | Default | Notes |
+|------|---------|-------|
+| `--db-url` | `postgresql+asyncpg://celerp:celerp@localhost:5432/celerp` | PostgreSQL connection URL |
+| `--api-port` | `8000` | API server port |
+| `--ui-port` | `8080` | UI server port |
+| `--cloud-token` | _(empty)_ | Celerp Connect token (optional) |
+| `--force` | off | Overwrite existing config |
+| `--yes` / `-y` | off | Skip the `--force` wipe confirmation (non-interactive) |
+| `--no-start` | off | Set up, then exit WITHOUT launching servers (service-managed/headless) |
+| `--embedded` | off | Force the bundled PostgreSQL even if a server is reachable (cannot combine with `--db-url`) |
+| `--no-embedded` | off | Never fall back to the bundled PostgreSQL; require an external server |
+
+To change ports after init, edit `~/.config/celerp/config.toml` directly.
+
+### External vs embedded PostgreSQL
+
+`celerp init` picks the database automatically, and **an existing server always wins**:
+
+1. `--db-url` given → that external server (no detection).
+2. else a PostgreSQL server reachable on `localhost:5432` → use it (as root, init
+   provisions the role/database via `sudo -u postgres psql`; otherwise it prints the
+   `CREATE USER`/`CREATE DATABASE` to run).
+3. else the **bundled** PostgreSQL 17 — a self-contained cluster under
+   `~/.config/celerp/pgdata`, started from binaries shipped in the
+   [`celerp-postgres`](https://github.com/celerp/celerp-postgres) wheel. No `sudo`, no
+   system service. Available on Linux x86_64/arm64 (glibc and musl/Alpine) and Windows
+   x64, any CPython; on macOS 26+ opt in with `pip install celerp-postgres`. Elsewhere
+   init asks you to install PostgreSQL.
+
+Override the detection with `--embedded` / `--no-embedded`. The chosen mode is written to
+`config.toml` as `[database] embedded = true|<absent>` and preserved across `--force`
+re-inits, so an external install never silently switches to the bundled cluster.
+
+**Moving bundled data to an external server** (e.g. outgrowing single-machine): dump from
+the bundled cluster and restore into the target, using the bundled tools so versions match.
+
+```bash
+BIN=$(celerp status >/dev/null; python -c "from celerp import embedded_pg; print(embedded_pg.bin_dir())")
+"$BIN/pg_dump" "$(python -c "from celerp import embedded_pg,pathlib; from celerp.config import config_path; print(embedded_pg.ensure_cluster(config_path().parent).replace('+asyncpg',''))")" \
+  | psql "postgresql://celerp:celerp@newhost:5432/celerp"
+celerp init --force --db-url "postgresql+asyncpg://celerp:celerp@newhost:5432/celerp"
+```
+
+### Run as a service (systemd)
+
+`celerp init` launches the servers and blocks (good for the one-command desktop
+flow). For a headless box where a process manager owns the lifecycle, set up with
+`--no-start` and let systemd run `celerp start`.
+
+Install Celerp into a virtual environment. `celerp start` installs updates itself,
+into the service user's Celerp config folder beside its data, so the install can stay
+root-owned. When the service user cannot write to that folder, the update card shows
+the pip command to run instead.
+
+```bash
+sudo useradd --system --create-home celerp
+sudo python3 -m venv /opt/celerp
+sudo /opt/celerp/bin/pip install celerp
+```
+
+```bash
+# First boot against a system PostgreSQL: provision DB + migrations + config, then
+# exit (do not block). Run as root so init can create the role/database.
+sudo /opt/celerp/bin/celerp init --no-start \
+  --db-url "postgresql+asyncpg://celerp:<password>@localhost:5432/celerp" \
+  --api-port 8000 --ui-port 8080
+```
+
+Prefer the bundled database? Drop `--db-url` (and the `sudo` — the bundled cluster needs
+neither) and run `celerp init --no-start` as the service user. The cluster then lives under
+that user's `~/.config/celerp/pgdata`, and the systemd unit needs no `postgresql.service`
+dependency.
+
+```ini
+# /etc/systemd/system/celerp.service
+[Unit]
+Description=Celerp
+# Drop the postgresql.service dependency line when using the bundled database.
+After=network.target postgresql.service
+
+[Service]
+ExecStart=/opt/celerp/bin/celerp start
+Restart=on-failure
+User=celerp
+
+[Install]
+WantedBy=multi-user.target
+```
+
+```bash
+sudo systemctl enable --now celerp
+```
+
+New versions install automatically between 03:00 and 05:00 in the company's time
+zone. Each update takes a backup first and is undone if the new version does not
+start. The owner can turn this off in the update card in the notifications panel, or
+set it in `config.toml`:
+
+```toml
+[updates]
+auto = false
+```
+
+## Troubleshooting
+
+| Error | Fix |
+|-------|-----|
+| `fe_sendauth: no password supplied` | Run `set -a && source .env && set +a` before alembic |
+| `password authentication failed` | Run `ALTER USER celerp WITH PASSWORD 'devpass';` via psql |
+| `role "celerp" does not exist` | Run the `CREATE USER` command from README |
+| `FATAL: JWT_SECRET is set to the default` | Generate with `openssl rand -hex 32` or set `ALLOW_INSECURE_JWT=true` |
+| `Directory 'static' does not exist` | Run uvicorn from the repo root, not a subdirectory |
+| `System already bootstrapped` | Drop and recreate the DB, or `DELETE FROM users;` via psql |
+
+## Module system
+
+Each module is a self-contained Python package under `default_modules/`. A module registers:
+
+- **API routes** via a FastAPI router
+- **Projections** that materialize ledger events into queryable state
+- **UI routes** via FastHTML
+- **Nav slots** for sidebar entries
+
+To add a new module, follow the pattern in any existing module (e.g. `celerp-inventory`). Modules are discovered and loaded at startup based on `ENABLED_MODULES`.
+
+## Coding style
+
+- DRY, SOLID, KISS
+- Small pure functions, explicit contracts, deterministic behavior
+- Tests use SQLite in-memory - no Postgres required
+- Name test files after the module they test
+- Use `conftest.py` for shared fixtures
+
+## License
+
+Celerp is multi-licensed (see [LICENSING.md](LICENSING.md)). Your contribution is governed by the
+**Contribution terms** at the top of this file (a signed CLA for anything accepted upstream, including
+the MIT modules; DCO for third-party modules you keep). License headers follow the per-path policy in
+`LICENSING.md` and are enforced by `scripts/licenses.py`.

celerp-2.5.3/PKG-INFO

@@ -0,0 +1,399 @@
+Metadata-Version: 2.4
+Name: celerp
+Version: 2.5.3
+Summary: Free, self-hosted ERP for small businesses
+License: Business Source License 1.1
+        
+        License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+        "Business Source License" is a trademark of MariaDB Corporation Ab.
+        
+        -----------------------------------------------------------------------------
+        
+        Parameters
+        
+        Licensor:             Noah Severs
+        Licensed Work:        Celerp
+                              The Licensed Work is (c) 2026 Noah Severs
+        Additional Use Grant: You may use the Licensed Work in production to operate
+                              Celerp for your own internal business purposes, including
+                              self-hosted use by your company and its affiliates. This
+                              Additional Use Grant does not include offering the Licensed
+                              Work, modified versions of the Licensed Work, or a
+                              substantially similar competing product as a hosted service,
+                              SaaS service, managed service, OEM product, or white-label
+                              product to third parties without a commercial agreement with
+                              Licensor.
+        
+        Change Date:          2029-01-01
+        
+        Change License:       Apache License, Version 2.0
+        
+        For information about alternative licensing arrangements for the Licensed Work
+        (including commercial licensing, OEM agreements, and white-label inquiries),
+        please contact https://celerp.com.
+        
+        -----------------------------------------------------------------------------
+        
+        Notice
+        
+        The Business Source License (this document, or the "License") is not an Open
+        Source license. However, the Licensed Work will eventually be made available
+        under an Open Source License, as stated in this License.
+        
+        -----------------------------------------------------------------------------
+        
+        Terms
+        
+        The Licensor hereby grants you the right to copy, modify, create derivative
+        works, redistribute, and make non-production use of the Licensed Work. The
+        Licensor may make an Additional Use Grant, above, permitting limited production
+        use.
+        
+        Effective on the Change Date, or the fourth anniversary of the first publicly
+        available distribution of a specific version of the Licensed Work under this
+        License, whichever comes first, the Licensor hereby grants you rights under
+        the terms of the Change License, and the rights granted in the paragraph
+        above terminate.
+        
+        If your use of the Licensed Work does not comply with the requirements
+        currently in effect as described in this License, you must purchase a
+        commercial license from the Licensor, its affiliated entities, or authorized
+        resellers, or you must refrain from using the Licensed Work.
+        
+        All copies of the original and modified Licensed Work, and derivative works of
+        the Licensed Work, are subject to this License. This License applies
+        separately for each version of the Licensed Work and the Change Date may vary
+        for each version of the Licensed Work released by Licensor.
+        
+        You must conspicuously display this License on each original or modified copy
+        of the Licensed Work. If you receive the Licensed Work in original or modified
+        form from a third party, the terms and conditions set forth in this License
+        apply to your use of that work.
+        
+        Any use of the Licensed Work in violation of this License will automatically
+        terminate your rights under this License for the current and all other
+        versions of the Licensed Work.
+        
+        This License does not grant you any right in any trademark or logo of Licensor
+        or its affiliates (provided that you may use a trademark or logo of Licensor
+        as expressly required by this License).
+        
+        TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN
+        "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS
+        OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE.
+        
+        MariaDB hereby grants you permission to use this License's text to license
+        your works, and to refer to it using the trademark "Business Source License",
+        as long as you comply with the Covenants of Licensor below.
+        
+        -----------------------------------------------------------------------------
+        
+        Covenants of Licensor
+        
+        In consideration of the right to use this License's text and the "Business
+        Source License" name and trademark, Licensor covenants to MariaDB, and to all
+        other recipients of the licensed work to be provided by Licensor:
+        
+        1. To specify as the Change License the GPL Version 2.0 or any later version,
+           or a license that is compatible with GPL Version 2.0 or a later version,
+           where "compatible" means that software provided under the Change License can
+           be included in a program with software provided under GPL Version 2.0 or a
+           later version. Licensor may specify additional Change Licenses without
+           limitation.
+        
+        2. To either: (a) specify an additional grant of rights to use that does not
+           impose any additional restriction on the right granted in this License, as
+           the Additional Use Grant; or (b) insert the text "None".
+        
+        3. To specify a Change Date.
+        
+        4. Not to modify this License in any other way.
+        
+Project-URL: Homepage, https://celerp.com
+Project-URL: Repository, https://github.com/celerp/celerp
+Project-URL: Documentation, https://celerp.com/docs
+Keywords: erp,inventory,accounting,self-hosted,fastapi
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: aiofiles==25.1.0
+Requires-Dist: aiosmtplib==5.1.3
+Requires-Dist: alembic==1.20.0
+Requires-Dist: annotated-doc==0.0.5
+Requires-Dist: annotated-types==0.8.0
+Requires-Dist: anyio==4.15.1
+Requires-Dist: async-timeout==5.0.1; python_full_version < "3.11"
+Requires-Dist: asyncpg==0.31.0
+Requires-Dist: bcrypt==5.0.0
+Requires-Dist: beautifulsoup4==4.15.0
+Requires-Dist: celerp-postgres==17.10.0; (platform_machine == "aarch64" and sys_platform == "linux") or (platform_machine == "x86_64" and sys_platform == "linux") or (platform_machine == "AMD64" and sys_platform == "win32")
+Requires-Dist: certifi==2026.7.22
+Requires-Dist: cffi==2.1.1; platform_python_implementation != "PyPy"
+Requires-Dist: charset-normalizer==3.5.1
+Requires-Dist: click==8.5.0
+Requires-Dist: colorama==0.4.6; sys_platform == "win32"
+Requires-Dist: cryptography==48.0.1; platform_machine == "x86_64" and sys_platform == "darwin"
+Requires-Dist: cryptography==50.0.1; platform_machine != "x86_64" or sys_platform != "darwin"
+Requires-Dist: deprecated==1.3.1; python_full_version < "3.12"
+Requires-Dist: deprecated==3.0.0; python_full_version >= "3.12"
+Requires-Dist: ecdsa==0.19.2
+Requires-Dist: et-xmlfile==2.0.0
+Requires-Dist: exceptiongroup==1.3.1; python_full_version < "3.11"
+Requires-Dist: fastapi==0.141.1
+Requires-Dist: fastcore==2.2.31
+Requires-Dist: greenlet==3.5.6
+Requires-Dist: h11==0.16.0
+Requires-Dist: httpcore==1.0.9
+Requires-Dist: httpcore2==2.13.1; sys_platform != "emscripten"
+Requires-Dist: httptools==0.8.0
+Requires-Dist: httpx==0.28.1
+Requires-Dist: httpx2==2.13.1
+Requires-Dist: httpx2-jsfetch==1.0; python_full_version >= "3.12" and sys_platform == "emscripten"
+Requires-Dist: idna==3.20
+Requires-Dist: itsdangerous==2.2.0
+Requires-Dist: limits==5.8.0
+Requires-Dist: mako==1.4.3
+Requires-Dist: markupsafe==3.0.3
+Requires-Dist: numpy==2.2.6; python_full_version < "3.11"
+Requires-Dist: numpy==2.4.6; python_full_version == "3.11.*"
+Requires-Dist: numpy==2.5.3; python_full_version >= "3.12"
+Requires-Dist: oauthlib==4.0.0
+Requires-Dist: openpyxl==3.1.5
+Requires-Dist: packaging==26.3
+Requires-Dist: passlib==1.7.4
+Requires-Dist: pillow==12.3.0
+Requires-Dist: psutil==7.2.2
+Requires-Dist: psycopg2-binary==2.9.13
+Requires-Dist: pyasn1==0.6.4
+Requires-Dist: pycparser==3.0; implementation_name != "PyPy" and platform_python_implementation != "PyPy"
+Requires-Dist: pydantic==2.13.5
+Requires-Dist: pydantic-core==2.46.5
+Requires-Dist: pydantic-settings==2.15.0
+Requires-Dist: pypdf==6.19.0
+Requires-Dist: python-barcode==0.16.1
+Requires-Dist: python-dateutil==2.9.0.post0
+Requires-Dist: python-dotenv==1.2.3
+Requires-Dist: python-fasthtml==0.14.13
+Requires-Dist: python-jose==3.5.0
+Requires-Dist: python-multipart==0.0.32
+Requires-Dist: pyyaml==6.0.3
+Requires-Dist: qrcode==8.2
+Requires-Dist: reportlab==5.0.1
+Requires-Dist: rsa==4.9.1
+Requires-Dist: six==1.17.0
+Requires-Dist: slowapi==0.1.10
+Requires-Dist: soupsieve==2.10
+Requires-Dist: sqlalchemy==2.0.54; python_full_version < "3.11"
+Requires-Dist: sqlalchemy==2.1.1; python_full_version >= "3.11"
+Requires-Dist: starlette==1.7.0
+Requires-Dist: tomli==2.4.1; python_full_version < "3.11"
+Requires-Dist: truststore==0.10.4; sys_platform != "emscripten"
+Requires-Dist: typing-extensions==4.16.0
+Requires-Dist: typing-inspection==0.4.4
+Requires-Dist: tzdata==2026.4
+Requires-Dist: uvicorn==0.54.0
+Requires-Dist: uvloop==0.22.1; platform_python_implementation != "PyPy" and sys_platform != "cygwin" and sys_platform != "win32"
+Requires-Dist: watchfiles==1.3.0
+Requires-Dist: websockets==16.1.1; python_full_version < "3.11"
+Requires-Dist: websockets==17.1; python_full_version >= "3.11"
+Requires-Dist: wrapt==2.5.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: faker>=24.0; extra == "dev"
+Requires-Dist: respx>=0.21; extra == "dev"
+Requires-Dist: playwright<1.62,>=1.43; extra == "dev"
+Requires-Dist: pytest-playwright>=0.5; extra == "dev"
+Requires-Dist: pytest-timeout>=2.3; extra == "dev"
+Requires-Dist: pytest-xdist>=3.5; extra == "dev"
+Requires-Dist: testcontainers[postgres]>=4.0; extra == "dev"
+Provides-Extra: prod
+Requires-Dist: gunicorn==26.2.0; extra == "prod"
+Dynamic: license-file
+
+# Celerp
+
+**Free business management software for you and your office. Setup in minutes. Easy enough for solo entrepreneurs and powerful enough for large enterprises**
+
+Inventory, invoicing, purchasing, consignment, manufacturing, accounting, and CRM - in one app, on your computer. No subscription. No cloud required.
+
+Website: [www.celerp.com](https://www.celerp.com)
+
+Celerp is simple to use, flexible, customizable, and designed to transition your business into the AI age with no technical knowledge needed to setup your whole office. We want to put businesses back in charge of their data.
+
+[![Downloads](https://static.pepy.tech/badge/celerp)](https://pepy.tech/project/celerp)
+[![Tests](https://github.com/celerp/celerp/actions/workflows/ci.yml/badge.svg)](https://github.com/celerp/celerp/actions)
+[![License](https://img.shields.io/badge/license-BUSL--1.1-blue)](LICENSE)
+
+<!-- PRESS_KIT:root-hero start -->
+![Celerp manufacturing cost worksheet](docs/press-kit/screenshots/manufacturing-worksheet.png)
+<!-- PRESS_KIT:root-hero end -->
+
+## Screenshots
+
+Real double-entry accounting, multi-location inventory, manufacturing, and a built-in REST API - one self-hosted app.
+
+<!-- PRESS_KIT:root-grid start -->
+| | |
+|---|---|
+| ![Dashboard with revenue trend, receivables aging, and inventory mix](docs/press-kit/screenshots/dashboard.png)<br>**Dashboard** - revenue trend, AR aging, inventory mix | ![Multi-location inventory with barcode scanning and valuation](docs/press-kit/screenshots/inventory.png)<br>**Inventory** - multi-location, barcode, valuation |
+| ![Double-entry trial balance that ties out to zero](docs/press-kit/screenshots/trial-balance.png)<br>**Trial balance** - ties out to zero | ![Balance sheet generated from the event-sourced ledger](docs/press-kit/screenshots/balance-sheet.png)<br>**Balance sheet** - live from the ledger |
+| ![Production planning by status, priority, and due date](docs/press-kit/screenshots/production-planning.png)<br>**Production planning** - work orders, priorities, due dates | ![International shipping document with commercial invoice and customs detail](docs/press-kit/screenshots/international-shipping-document.png)<br>**Shipping documents** - commercial invoice and customs |
+| ![Built-in REST API for integrations](docs/press-kit/screenshots/rest-api.png)<br>**REST API** - integrate anything | ![Customer statement of account showing receivables](docs/press-kit/screenshots/statement-of-account.png)<br>**Statement of account** - customer AR at a glance |
+<!-- PRESS_KIT:root-grid end -->
+
+More in the [press kit](docs/press-kit/).
+
+---
+
+## Install
+
+| Platform | Link |
+|----------|------|
+| Windows (.exe) | [Download](https://celerp.com/download-thanks.html?dl=win) |
+| Linux (.deb) | [Download](https://celerp.com/download-thanks.html?dl=linux) |
+| macOS (.dmg) | [Download](https://celerp.com/download-thanks.html?dl=mac) |
+
+**Double-click. No account. No credit card. Your computer securely becomes the server for your office**
+
+Or install via pip:
+
+```bash
+pip install celerp
+celerp init        # sets up the database and launches Celerp
+```
+
+Open **http://localhost:8080**. Done.
+Your office can securely access the system at your IP address :8080.
+
+No PostgreSQL to install: `celerp init` uses your existing PostgreSQL server if one is
+running, and otherwise starts a self-contained bundled database — no `sudo`, no system
+service. Point it at a specific server with `celerp init --db-url postgresql+asyncpg://…`.
+
+Running headless or under a process manager? Use `celerp init --no-start` to set up
+without launching, then have your service run `celerp start` — see
+[Run as a service (systemd)](CONTRIBUTING.md#run-as-a-service-systemd).
+Updates install automatically overnight; the owner can turn that off from the update
+card in the notifications panel.
+
+---
+
+## What's inside
+
+- Track inventory across locations, scan barcodes, print labels
+- Send invoices, purchase orders, quotations, credit notes
+- Double-entry accounting with chart of accounts, P&L, balance sheet
+- Connect Shopify, WooCommerce, QuickBooks, Xero
+- Manufacturing - BOMs, production orders, merge/split/transform
+- CRM - contacts, pipeline, memos, activity feed
+- Recurring subscriptions with automatic invoicing
+- CSV import/export everything - idempotent, audited, column-mapped
+- Multi-company from one install
+- Role-based permissions - five access levels (viewer, operator, manager, admin, owner) for controlled employee access
+- Works offline, no internet required
+
+---
+
+## How it works
+
+Celerp runs on your machine and keeps its primary database local. Optional Connect features can relay remote access or send selected data to Celerp cloud services.
+
+- **No setup** - the desktop app bundles Postgres, runs migrations on launch, opens in your browser
+- **No lock-in** - your data stays in a standard Postgres database you control
+- **Teams** - run as a local server, teammates connect over the LAN
+
+---
+
+## Modules
+
+Every business domain is a self-contained module. The full set ships with the download:
+
+| Module | What it does |
+|--------|-------------|
+| `celerp-inventory` | Items, stock levels, locations, barcode scanning, valuation |
+| `celerp-contacts` | Contacts, addresses, tags, notes, file attachments |
+| `celerp-docs` | Invoices, POs, quotations, credit notes, receipts |
+| `celerp-accounting` | Chart of accounts, journal entries, P&L, balance sheet |
+| `celerp-reports` | AR/AP aging, sales, purchases, inventory valuation |
+| `celerp-subscriptions` | Recurring billing, auto-invoice generation |
+| `celerp-manufacturing` | BOMs, production orders, merge/split/transform |
+| `celerp-labels` | Label printing, barcode generation |
+| `celerp-verticals` | Industry presets - configure for your business type on first run |
+
+The onboarding wizard lets you pick your industry. Modules can be toggled any time at **Settings > Modules**.
+
+### Build your own
+
+> "My vision for Celerp is that anyone with AI coding tools can describe what their business needs and get a module that imports right into the system."
+>
+> Noah Severs, Founder
+
+Every feature above is a module on one loader API, and you can build against the same API. A module is a Python package you drop into Celerp's `modules/` folder; it adds its own tables, API routes, and UI pages, no fork or build step.
+
+- [**celerp-module-template**](https://github.com/celerp/celerp-module-template) - a working example module you can run in about ten minutes, plus a lint script
+- [**Build a module**](https://www.celerp.com/docs/modules) - the guide
+- [**community-modules**](https://github.com/celerp/community-modules) - a directory of community-built modules, and how to list yours
+
+---
+
+## Architecture
+
+- **Event-sourced** - every change is an immutable ledger entry, projections materialize queryable state
+- **Modular** - each domain is a plugin with its own models, routes, and projections
+- **Python/FastAPI** backend, **FastHTML** UI, embedded **PostgreSQL**
+- SQLite in-memory for tests - no external dependencies to run the test suite
+
+---
+
+## Development
+
+```bash
+git clone git@github.com:celerp/celerp.git
+cd celerp
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+celerp init   # creates DB, runs migrations, starts servers
+```
+
+`celerp init` boots a bundled PostgreSQL when no server is running, so no `sudo` and no
+system Postgres are required. To develop against your own server instead, pass
+`--db-url postgresql+asyncpg://…`.
+
+Open **http://localhost:8080**. Run tests with `pytest tests/`.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for environment variables, troubleshooting, and coding guidelines.
+
+---
+
+## Contributing
+
+Issues and PRs welcome. The module system makes it straightforward to add new business domains without touching the kernel.
+
+---
+
+## License
+
+**Free to download. Free to self-host. Free to build on.**
+
+Celerp is open-core:
+
+- **Source-available core engine** under the [Business Source License 1.1](LICENSE) -
+  self-hosting permitted, contributions welcome.
+- **An MIT-licensed module ecosystem** - the default business modules are MIT, so you can
+  fork them, build your own modules, and ship them however you like. See [LICENSING.md](LICENSING.md).
+- **A source available application** (official UI, document/PDF output and AI & Connect services).
+
+See [LICENSING.md](LICENSING.md) for the full map and [TRADEMARK.md](legal/TRADEMARK.md) for use of the Celerp
+name. One restriction: don't resell Celerp itself as a competing product.