tabalyst 0.5.0__tar.gz → 0.6.0__tar.gz

tabalyst-0.6.0/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

{tabalyst-0.5.0/src/tabalyst.egg-info → tabalyst-0.6.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: tabalyst
-Version: 0.5.0
+Version: 0.6.0
 Summary: Open-source toolkit for understanding and working with unfamiliar data.
 Author: Gregory Borelli
-License-Expression: MIT
+License-Expression: MPL-2.0
 Project-URL: Homepage, https://github.com/loribel-labs/tabalyst
 Project-URL: Repository, https://github.com/loribel-labs/tabalyst.git
 Project-URL: Issues, https://github.com/loribel-labs/tabalyst/issues
@@ -26,12 +26,14 @@ Requires-Dist: ijson>=3.3
 Requires-Dist: jinja2>=3.1
 Requires-Dist: platformdirs>=4
 Requires-Dist: pydantic>=2.11
+Requires-Dist: python-calamine>=0.8
 Requires-Dist: typer>=0.12
 Provides-Extra: dev
 Requires-Dist: build>=1.2; extra == "dev"
 Requires-Dist: pytest>=8; extra == "dev"
 Requires-Dist: pytest-cov>=6; extra == "dev"
 Requires-Dist: ruff>=0.11; extra == "dev"
+Requires-Dist: xlsxwriter>=3; extra == "dev"
 Dynamic: license-file
 
 # Tabalyst
@@ -44,8 +46,8 @@ with structured data.
 Its first tool is **Tabalyst Report**. The current CSV implementation,
 **Tabalyst CSV Report**, analyzes a CSV file and produces both a structured JSON
 profile and a self-contained interactive HTML report.
-**Tabalyst Scan** describes CSV, JSON and JSONL files in a scan document,
-**Tabalyst Inspect** finds how to read a JSON or JSONL file, and
+**Tabalyst Scan** describes CSV, JSON, JSONL and Excel files in a scan document,
+**Tabalyst Inspect** finds how to read a JSON, JSONL or Excel file, and
 **Tabalyst Sample** creates smaller CSV files.
 
 Tabalyst is in beta. Its interfaces may still change while
@@ -72,6 +74,7 @@ changes often: update it before each new test.
 | Several files, one directory | `tabalyst report *.csv -d reports/` | The directory `reports/` |
 | One JSON file | `tabalyst report data.json` | `data.report.html` beside the source |
 | One JSONL file | `tabalyst report events.jsonl` | `events.report.html` beside the source |
+| One Excel workbook | `tabalyst report sales.xlsx` | `sales.report.html` beside the source |
 | From a scan document | `tabalyst report --scan data.scan.json` | `data.html` beside the scan |
 
 The simplest command keeps the source filename:
@@ -128,6 +131,22 @@ partial. When a JSON file holds several arrays that are equally plausible,
 Tabalyst stops and lists them instead of choosing: see
 [Tabalyst Inspect](#tabalyst-inspect).
 
+### Excel workbooks
+
+An `.xlsx` or `.xlsm` workbook gets a report too, named `<stem>.report.html`. The
+report analyzes one table, a sheet or a named Excel table, and its columns are
+the cells of the header, which Tabalyst finds even under a title:
+
+```console
+tabalyst report sales.xlsx
+```
+
+Cells keep their Excel type, and dates are read as dates. A workbook with one
+table needs nothing else. When several sheets or tables are equally plausible,
+Tabalyst stops and lists them instead of choosing: pass `--collection Costs` (or
+`'$.Sales.Orders'` for a named table), or see [Tabalyst Inspect](#tabalyst-inspect).
+Older `.xls` files are not read: save them as `.xlsx`.
+
 ### Multiple files
 
 Report several CSV files at once:
@@ -247,9 +266,10 @@ require `--force`, and an input file is never overwritten.
 
 ## Tabalyst Inspect
 
-A JSON file can hold several arrays. **Tabalyst Inspect** reads a JSON, JSONL
-or NDJSON file once, finds which array holds the records and writes its answer
-in `<source>-inspect.json` beside the source:
+A JSON file can hold several arrays, and an Excel workbook several sheets.
+**Tabalyst Inspect** reads a JSON, JSONL, NDJSON or Excel file once, finds which
+array, sheet or table holds the records and writes its answer in
+`<source>-inspect.json` beside the source:
 
 ```console
 tabalyst inspect orders.json
@@ -270,18 +290,37 @@ Inspect is optional: `tabalyst scan` and `tabalyst report` inspect a JSON file
 themselves when it has no Inspect file. When several arrays are equally
 plausible, or none holds objects, they stop with exit code `2` before analyzing
 anything and list the candidates; set `config.structure.dataset_path` in the
-Inspect file, or pass `--collection`. See
-[Inspect JSON and JSONL files](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/how-to/inspect-json-files.md)
-and the [Inspect format](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/reference/inspect-format.md).
+Inspect file, or pass `--collection` (`--collection customers` or
+`--collection '$.customers[]'`). See
+[Inspect JSON and JSONL files](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/inspect/json.md)
+and the [Inspect format](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/inspect/format.md).
+
+For a workbook, Inspect lists the sheets and named tables, proposes one and
+writes the same kind of file:
+
+```console
+tabalyst inspect sales.xlsx
+```
+
+```text
+Inspect: sales.xlsx-inspect.json
+Selection: $.Orders (much larger than $.Regions)
+```
+
+Its `config` holds `structure.dataset_path` (`$.Orders` for a sheet,
+`$.Orders.Table1` for a named table) and `structure.header_row`, to set the header
+row when the detection picks the wrong one. See
+[Inspect Excel workbooks](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/inspect/excel.md).
 
 ## Tabalyst Scan
 
-Describe every field of a CSV, JSON or JSONL file in one JSON document:
+Describe every field of a CSV, JSON, JSONL or Excel file in one JSON document:
 
 ```console
 tabalyst scan customers.csv
 tabalyst scan orders.json --collection "$.customers[]"
 tabalyst scan events.jsonl
+tabalyst scan sales.xlsx --collection Orders
 ```
 
 Without `-o` or `-d`, the scan is a reusable `scan.json` under Tabalyst's local
@@ -301,7 +340,7 @@ chooses their number, `--workers 1` keeps one process.
 
 `tabalyst report customers.csv` reuses the verified stored scan when the
 source content and requested scan settings are current, and so does a report on
-a JSON or JSONL file. It creates a scan when none exists and atomically replaces
+a JSON, JSONL or Excel file. It creates a scan when none exists and atomically replaces
 a stale one. The source check uses the SHA-256 of the whole content, and a scan
 written by another version of Tabalyst is replaced. Existing DuckDB projects from 0.4.3 are left
 untouched.
@@ -328,8 +367,8 @@ tabalyst cache clean customers.csv
 `cache clean` leaves project scans and databases in place. Ordinary scans and
 reports do not create these query caches.
 
-See [Scan CSV and JSON files](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/how-to/scan-files.md)
-and the [scan format](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/reference/scan-format.md).
+See [Scan CSV and JSON files](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/scan/files.md)
+and the [scan format](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/scan/format.md).
 
 ## What the report analyzes
 
@@ -378,7 +417,7 @@ scan = tabalyst.scan("orders.json")
 scans = tabalyst.generate_scans(["data/*.json"], output_dir="scans")
 
 inspection = tabalyst.inspect("orders.json")
-inspections = tabalyst.generate_inspections(["data/*.json", "logs/*.jsonl"])
+inspections = tabalyst.generate_inspections(["data/*.json", "logs/*.jsonl", "*.xlsx"])
 reports = tabalyst.generate_reports(["scans/*.scan.json"], from_scan=True)
 ```
 
@@ -387,9 +426,9 @@ reports = tabalyst.generate_reports(["scans/*.scan.json"], from_scan=True)
 `scan()` returns a scan result without writing anything, at the level of the
 engine: it does not read an Inspect file. `generate_scans()` writes one
 standalone `.scan.json` document per source by default, and applies Inspect to
-JSON and JSONL sources. Pass `project_storage=True` to use the command's
-scan-only storage. `inspect()` writes the Inspect file of one JSON or JSONL
-source and returns its path and document; `generate_inspections()` does it for
+JSON, JSONL and Excel sources. Pass `project_storage=True` to use the command's
+scan-only storage. `inspect()` writes the Inspect file of one JSON, JSONL or
+Excel source and returns its path and document; `generate_inspections()` does it for
 several sources. `from_scan=True`
 builds reports from standalone scan documents.
 Expected failures derive from `tabalyst.TabalystError`.
@@ -436,6 +475,10 @@ will require later work. Inspect reads a JSON or JSONL source once from start to
 end, with little memory; on the synthetic benchmarks it took roughly a tenth of the
 time of a scan, a ratio that depends on the data.
 
+An Excel workbook is read by sheet into memory (about 0.9 byte per byte of sheet
+XML), so a sheet of a million rows of eight columns takes about 4 seconds and
+360 MB to read. A sheet above 1 GiB of XML is refused.
+
 ## Examples and development
 
 The repository includes small and synthetic public examples under `examples/`.
@@ -452,7 +495,9 @@ Additional documentation:
 
 - [Architecture](https://github.com/loribel-labs/tabalyst/blob/main/docs/dev/architecture.md)
 - [Configuration](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/reference/configuration.md)
-- [Inspect JSON and JSONL files](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/how-to/inspect-json-files.md)
+- [Inspect JSON and JSONL files](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/inspect/json.md)
+- [Inspect Excel workbooks](https://github.com/loribel-labs/tabalyst/blob/main/docs/en/inspect/excel.md)
+- [Documentation site](https://docs.tabalyst.com/)
 - [Release procedure](https://github.com/loribel-labs/tabalyst/blob/main/RELEASING.md)
 
 Please report defects and feature requests through the
@@ -460,6 +505,6 @@ Please report defects and feature requests through the
 
 ## License
 
-Tabalyst is released under the [MIT License](LICENSE).
+Tabalyst is released under the [Mozilla Public License 2.0](LICENSE).
 
 Created by Gregory Borelli — Catalyseur Numérique.