drscore 1.0.0__tar.gz

drscore-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

drscore-1.0.0/PKG-INFO

@@ -0,0 +1,328 @@
+Metadata-Version: 2.4
+Name: drscore
+Version: 1.0.0
+Summary: DRS - Dynamic Report System: reports written in SQL, shown as grids, HTML designs and BI dashboards
+License-Expression: Apache-2.0
+Project-URL: Source, https://github.com/tanthanhkaka01/drscore
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_LICENSES.md
+License-File: drscore/admin/templates/sqladmin/LICENSE.sqladmin
+License-File: drscore/web/static/vendor/echarts/LICENSE
+License-File: drscore/web/static/vendor/htmx/LICENSE
+License-File: drscore/web/static/vendor/superset-embedded-sdk/LICENSE
+License-File: drscore/web/static/vendor/tabler-icons/LICENSE
+License-File: drscore/web/static/vendor/tabler/LICENSE
+License-File: drscore/web/static/vendor/tabulator/LICENSE
+License-File: drscore/web/static/vendor/echarts/NOTICE
+Requires-Dist: fastapi==0.142.2
+Requires-Dist: pydantic==2.13.5
+Requires-Dist: uvicorn==0.54.0
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: python-multipart==0.0.32
+Requires-Dist: sqlalchemy==2.1.3
+Requires-Dist: alembic==1.20.0
+Requires-Dist: psycopg[binary]==3.3.6
+Requires-Dist: pyodbc==5.3.0
+Requires-Dist: pymssql==2.4.3
+Requires-Dist: oracledb==26.0.1
+Requires-Dist: argon2-cffi==25.1.0
+Requires-Dist: cryptography==50.0.2
+Requires-Dist: authlib==1.8.0
+Requires-Dist: httpx==0.28.1
+Requires-Dist: xlsxwriter==3.2.9
+Requires-Dist: sqladmin==0.32.0
+Requires-Dist: wtforms==3.2.2
+Requires-Dist: babel==2.18.0
+Requires-Dist: itsdangerous==2.2.0
+Requires-Dist: greenlet==3.5.6
+Provides-Extra: test
+Requires-Dist: pytest==9.1.1; extra == "test"
+Requires-Dist: openpyxl==3.1.5; extra == "test"
+Dynamic: license-file
+
+# DRS - Dynamic Report System
+
+A web portal for reports where a report is **data, not code**: rows in the DRS database say which
+source to read, which SQL or procedure to run, which parameters to ask for, how to show the result
+and who may see it.
+
+Status: **milestone 8 (admin pages, metadata export / import, audit log)** done, on top of
+milestone 6 (BI with Superset, without row-level security in the guest token) and milestone 5 (design registry, HTML, report views as tabs) - the web portal on Tabler (sign-in, menu
+by report group, report page with parameter form, Tabulator grid, XLSX / CSV / TXT export, account
+page, Vietnamese / English), HTML reports rendered from design files, BI reports in link mode and
+the "no design, no view" rule, on top of the report engine (SQL Server 2008 R2+, Oracle,
+PostgreSQL, SQLite sources; JSON cache with history and lock), permissions and the dual-engine DRS
+database.
+
+## Install
+
+```bash
+pip install drscore
+python -m drscore init                            # config/, designs/, runtime/ in this folder (or DRS_HOME)
+python -m drscore serve                           # http://127.0.0.1:8080 - admin / admin, changed at the first sign-in
+```
+
+The database is SQLite under `runtime/` until `config/database.toml` says otherwise. From a copy of
+this repository instead: `pip install .`, then copy `config/*.example.toml` to `config/*.toml`.
+Running on a server, as a service or in containers: `docs/deployment.md`.
+
+## Quick look with the demo
+
+```bash
+python -m drscore db upgrade
+python -m drscore seed-demo                       # prints the demo passwords once
+python -m drscore serve                           # http://127.0.0.1:8080, sign in as hr_aaa, hr_all, viewer or admin
+```
+
+Or from the command line:
+
+```bash
+python -m drscore report run --code EMP_LIST --as-user hr_aaa
+python -m drscore grant show --user hr_all
+```
+
+## The portal
+
+| Page | Address |
+| --- | --- |
+| Sign in | `/login` |
+| Home: the user's report groups and reports, with search | `/` |
+| A report: parameters, Run, grid, Refresh (with `can_refresh`), XLSX / CSV / TXT (with `can_export`) | `/reports/{code}` |
+| Own account: change password, language | `/account` |
+| Administration (administrators only): groups, reports, parameters, columns, row filters, datasources, users, attributes, roles, grants, logs - with Test run, Test connection, Unlock | `/admin/` |
+
+Exports are made on the server from the snapshot on screen, with the same permission check and row
+filter, and contain all rows the user may see (not only the filtered page).
+
+JSON API: `GET /api/me`, `GET /api/menu`, `GET /api/reports/{code}`, `POST /api/reports/{code}/run`,
+`GET /api/reports/{code}/export?format=xlsx|csv|txt&snapshot_id=`, `GET /healthz`. A state-changing
+request carries the session's CSRF token in `X-CSRF-Token`.
+
+## How the report cache works
+
+- One table, `drs_report_snapshot`, holds the cached result (JSON) of every report.
+- Each time someone opens a report, its retention (`drs_report.cache_ttl_seconds`) is checked.
+  Still valid: the cached result is shown. Expired: the old snapshot is moved to
+  `drs_report_snapshot_history` and the data is read again from the source.
+- Reading again happens under a lock per (report, parameters): when several people open the same
+  report at once the source runs once and everyone gets the same result.
+- Nothing is deleted: `drs_report_snapshot_history` keeps every old snapshot, for every report.
+  `cache purge` moves all expired snapshots there at once (for reports nobody opens); `cache clear
+  --report CODE` moves all snapshots of one report.
+
+## Report views: Grid, Layout (HTML), Dashboard (BI)
+
+Every report opens with tabs:
+
+| Tab | Shown when | What it shows |
+| --- | --- | --- |
+| Grid | the report has a query and `grid_enabled = true` (the default) | the rows, sort / filter / pages, XLSX / CSV / TXT export |
+| Layout | `html_design_uri` is set (or `report_type = 'HTML'`) | the HTML design file, e.g. `file:html/att_summary.html` |
+| Dashboard | `bi_design_uri` is set (or `report_type = 'BI'`) | a BI dashboard: `superset:<embedded uuid>` (embedded, guest token from DRS) or an `http(s)://` link |
+
+`report_type` (GRID / HTML / BI, default GRID) is the tab the page opens on. All tabs show the same
+data (one run, one snapshot); permissions and the row filter are the same on every tab.
+
+A new report needs only its group, datasource and query: it appears in the menu at once and opens
+on its grid. Designs come later, one `UPDATE` each, no restart:
+
+```sql
+UPDATE drs_report SET html_design_uri = 'file:html/att_summary.html' WHERE report_code = 'ATT_SUMMARY';
+UPDATE drs_report SET bi_design_uri = 'https://bi.company.local/superset/dashboard/7/' WHERE report_code = 'HR_DASHBOARD';
+```
+
+A tab whose design is missing shows "This report has no design yet" (`DESIGN_NOT_SET`); the other
+tabs work. `python -m drscore report validate` lists the state of every design.
+
+Print / PDF: the Layout tab and the Grid tab have a "Print / Save PDF" button that opens the
+browser's print dialog (choose "Save as PDF"); the Grid prints every row the user may see. A
+Superset dashboard is saved as PDF with Superset's own "Download" menu.
+
+## BI with Apache Superset
+
+A BI report with `bi_dataset_table` feeds a table (`drs_bi.<name>` on PostgreSQL; table `<name>` of
+the datasets file `runtime/bi/datasets.sqlite3` on SQLite) from its
+result, following its retention; a Superset dashboard designed on that table is shown in the
+Dashboard tab, embedded with a guest token issued by DRS (the user needs no Superset account).
+Setup: `docker/compose.yml` and `docs/superset-setup.md`. Row-level security in the guest token is
+not built yet: a report with row-filter rules cannot be embedded.
+
+## Administration
+
+Everything can be done without SQL on the admin pages (`/admin/`, administrators only, see
+`docs/admin-guide.md`): every save is validated and written to the audit log. Reports designed on
+SQLite move to PostgreSQL with `metadata export` / `metadata import`.
+
+## Report sources
+
+| `db_type` | Versions | Driver (`drs_datasource.driver`) | Notes |
+| --- | --- | --- | --- |
+| `mssql` | SQL Server 2008 R2 and later | empty = pyodbc + ODBC Driver 18; an ODBC driver name; `pymssql` | 2008 R2: use `pymssql`, or set `{"Encrypt": "no"}` in `options_json`. pyodbc needs the Microsoft ODBC driver (and unixODBC on Linux). |
+| `oracle` | 12.1 and later (thin); 11.2 with `thick` | empty / `thin`; `thick` | `--database` is the service name; option `sid` to connect by SID; option `lib_dir` = Instant Client folder for thick mode. |
+| `postgresql` | 10 and later (tested with 16) | - | Runs every report in a read-only transaction. |
+| `sqlite` | - | - | `--database` is the file path; opened read-only. Used by the demo. |
+
+Every connection setting is a column of `drs_datasource`, as a DBA tool such as Navicat or
+DBeaver keeps it:
+
+| Setting | Column | `datasource add` option |
+| --- | --- | --- |
+| Description | `description` | `--description` |
+| Server, port | `host`, `port` | `--host`, `--port` |
+| SQL Server named instance | `instance_name` | `--instance SQLEXPRESS` |
+| Database (Oracle: service name, or SID) | `database_name`, `oracle_connect_by` | `--database`, `--sid` |
+| Default schema (PostgreSQL, Oracle) | `default_schema` | `--schema` |
+| Authentication | `auth_method`: password / windows / none | `--auth` |
+| User, password | `username`, `secret_ref` (encrypted, or `env:VARIABLE`) | `--user`, hidden prompt or `--password-env` |
+| SSL / encryption | `ssl_mode`: disable / prefer / require / verify; `trust_server_certificate` | `--ssl-mode`, `--trust-server-certificate` |
+| Connect timeout | `connect_timeout_seconds` (default 15) | `--connect-timeout` |
+| Driver | `driver` | `--driver` |
+| Any other driver option | `options_json` | `--option KEY=VALUE` |
+
+The password is asked at a hidden prompt and stored encrypted; `DRS_SECRET_KEY` must be set
+(`python -m drscore secret new-key` prints one).
+
+```bash
+python -m drscore datasource add HRMS_PROD --type mssql --host 10.0.0.8 --database HRMS --user drs_ro \
+    --description "HRMS production, read-only login"
+python -m drscore datasource add HRMS_OLD --type mssql --host 10.0.0.5 --instance SQL2008 --database HR \
+    --user drs_ro --ssl-mode disable --driver "ODBC Driver 17 for SQL Server"
+python -m drscore datasource add ERP --type oracle --host 10.0.0.9 --database ORCLPDB1 --schema HR --user drs_ro
+python -m drscore datasource add DWH --type postgresql --host 10.0.0.7 --database dwh --schema report \
+    --user drs_ro --ssl-mode require
+python -m drscore datasource show HRMS_PROD          # every setting, never the password
+python -m drscore datasource test HRMS_PROD          # connect and run a trivial query
+python -m drscore datasource set-password HRMS_PROD  # new password, encrypted
+```
+
+The login of a source must be read-only there (SELECT, and EXECUTE on the report procedures).
+
+Every component is free (requirement R02); see `THIRD_PARTY_LICENSES.md`.
+
+## Deploying on a server
+
+`docs/deployment.md` is the full guide: PostgreSQL preparation, installation, configuration and
+secrets, first start, Linux service (systemd) or Windows service (NSSM), HTTPS behind nginx / IIS,
+source drivers, backup, upgrade, every configuration key, troubleshooting. Sample files are in
+`deploy/`.
+
+In short, with PostgreSQL:
+
+```bash
+psql -U postgres -f deploy/postgres/create_drs_database.sql   # login drs_app + database drs (edit the password)
+python3 -m venv .venv && .venv/bin/pip install .
+cp config/database.example.toml config/database.toml          # active = "postgresql", [postgresql] host / user
+cp config/app.example.toml config/app.toml
+.venv/bin/python -m drscore secret new-key                        # once; keep the key safe
+export DRS_DB_PASSWORD='...' DRS_SECRET_KEY='<the key>'      # a service reads them from /etc/drs/drs.env
+.venv/bin/python -m drscore serve          # creates schema "drs", every table and the administrator, then serves
+```
+
+`serve` connects, creates or migrates the DRS database (`[app] auto_migrate = true`), gives a
+database without an administrator the default one (`admin` / `admin`, to be changed at the first
+sign-in), checks the set-up (secret key, HTTPS cookie, administrator) and starts `[app] workers`
+processes.
+
+## Requirements
+
+- Python 3.11 or newer
+- For production: PostgreSQL 14 or newer. For design and test nothing else is needed (SQLite).
+
+## First install
+
+Windows (PowerShell):
+
+```powershell
+cd D:\Projects\DRS
+py -3 -m venv .venv
+.\.venv\Scripts\Activate.ps1
+pip install -e ".[test]"
+Copy-Item config\database.example.toml config\database.toml
+Copy-Item config\app.example.toml config\app.toml
+python -m drscore db upgrade
+python -m drscore db check
+```
+
+Linux:
+
+```bash
+cd /path/to/DRS
+python3 -m venv .venv
+. .venv/bin/activate
+pip install -e ".[test]"
+cp config/database.example.toml config/database.toml
+cp config/app.example.toml config/app.toml
+python -m drscore db upgrade
+python -m drscore db check
+```
+
+The real config files are git-ignored; only the `*.example.toml` files are committed. The config
+folder can be moved with the environment variable `DRS_CONFIG_DIR`.
+
+## Choosing the DRS database engine
+
+`config/database.toml` alone decides it:
+
+```toml
+active = "sqlite"        # or "postgresql"
+```
+
+To switch: change `active` (or set the environment variable `DRS_DB_ACTIVE`), then run
+`python -m drscore db upgrade`. No code changes.
+
+For PostgreSQL, fill the `[postgresql]` section and put the password in the environment variable it
+names (default `DRS_DB_PASSWORD`). The tables are created in the schema `schema` (default `drs`);
+`db upgrade` creates the schema when it is missing.
+
+## Secrets
+
+`python -m drscore secret new-key` prints a new encryption key. Put it in the environment variable named
+by `app.secret_key_env` (default `DRS_SECRET_KEY`). It encrypts datasource passwords.
+
+## Tests
+
+```bash
+python -m pytest                       # SQLite
+DRS_TEST_PG_URL=postgresql://user:password@127.0.0.1:5432/dbname python -m pytest   # SQLite and PostgreSQL
+```
+
+With `DRS_TEST_PG_URL` set, every database test runs twice, once per engine. On PostgreSQL each
+run uses a throw-away schema, dropped at the end. Use a test database, never a production one.
+
+## Commands available so far
+
+| Command | Purpose |
+| --- | --- |
+| `python -m drscore db upgrade` | Create / migrate the DRS database on the active engine |
+| `python -m drscore db check` | Active engine, migration version, every table reachable |
+| `python -m drscore secret new-key` | Print a new encryption key |
+| `python -m drscore serve [--host H] [--port P] [--workers N]` | Create / migrate the DRS database if needed, check the set-up, start the web server |
+| `python -m drscore user add NAME [--display-name D] [--email E] [--admin] [--sso-subject S] [--no-password]` | Add a user; the password is asked at a hidden prompt |
+| `python -m drscore user list / disable / enable / set-password / set-admin [--off]` | Users |
+| `python -m drscore user attr set USER NAME VALUE... / remove USER NAME [VALUE] / list USER` | Row-filter attributes (`*` = every value) |
+| `python -m drscore role add CODE [--name N] / list / member add CODE USER / member remove CODE USER` | Roles |
+| `python -m drscore grant group CODE / grant report CODE --user U \| --role R [--export\|--no-export] [--refresh\|--no-refresh]` | Grants |
+| `python -m drscore revoke group CODE / revoke report CODE --user U \| --role R` | Remove a grant |
+| `python -m drscore grant show --user U` | What a user can see, and through which grant |
+
+The first administrator is made by `serve`: a DRS database without an administrator gets user
+`admin` with the password `admin`. That password opens only the account page, where it must be
+replaced at the first sign-in. Another administrator:
+
+```bash
+python -m drscore user add NAME --display-name "Administrator" --admin
+```
+
+| Command | Purpose |
+| --- | --- |
+| `python -m drscore datasource add / list / test` | Report sources |
+| `python -m drscore report run --code C --as-user U [--param k=v ...] [--format grid\|json] [--refresh] [--out F]` | Run a report exactly as that user gets it |
+| `python -m drscore report validate [--code C]` | Check report definitions and design state |
+| `python -m drscore cache purge [--report C]` | Move every expired snapshot to the history |
+| `python -m drscore cache clear --report C` | Move every snapshot of one report to the history |
+| `python -m drscore cache warm [--report C]` | Run reports with their default parameters ahead of the users |
+| `python -m drscore metadata export --out F [--report C ...]` | Report definitions, datasources (no secrets), users (no passwords), roles and grants as one JSON file |
+| `python -m drscore metadata import --in F [--dry-run]` | Create / update them in this DRS database, matched by code (e.g. SQLite to PostgreSQL) |
+| `python -m drscore seed-demo [--force]` | Demo source, reports, role and users |