heurist-api 0.2.1__py3-none-any.whl → 0.2.2a0__py3-none-any.whl

heurist/cli/load.py

@@ -45,8 +45,11 @@ def load_command(
     # Show the results of the created DuckDB database
     with duckdb.connect(duckdb_database_connection_path, read_only=True) as new_conn:
         tables = [t[0] for t in new_conn.sql("show tables;").fetchall()]
-        with open(VALIDATION_LOG) as f:
-            log = f.readlines()
+        if VALIDATION_LOG.is_file():
+            with open(VALIDATION_LOG) as f:
+                log = f.readlines()
+        else:
+            log = []
         show_summary_in_console(tables=tables, log_lines=log)
 
         # If writing to CSV files, write only tables of record types
@@ -62,7 +65,7 @@ def load_command(
                 new_conn.table(table_name).sort("H-ID").write_csv(str(fp))
 
 
-def show_summary_in_console(tables: list[str], log_lines: list[str]):
+def show_summary_in_console(tables: list[str], log_lines: list):
     console = Console()
     t0 = Panel(
         Columns(tables, equal=True, expand=True),

heurist/log/constants.py

@@ -1,4 +1,3 @@
 from pathlib import Path
 
 VALIDATION_LOG = Path.cwd().joinpath("validation.log")
-VALIDATION_LOG.touch(exist_ok=True)

heurist/validators/record_validator.py

@@ -8,7 +8,7 @@ from heurist.validators.detail_validator import DetailValidator
 from heurist.validators.exceptions import RepeatedValueInSingularDetailType
 from pydantic import BaseModel
 
-handlers = [logging.FileHandler(filename=VALIDATION_LOG, mode="w", delay=True)]
+handlers = [logging.FileHandler(filename=VALIDATION_LOG, mode="w")]
 if os.getenv("HEURIST_STREAM_LOG") == "True":
     handlers.append(logging.StreamHandler())
 

{heurist_api-0.2.1.dist-info → heurist_api-0.2.2a0.dist-info}/METADATA

@@ -1,9 +1,7 @@
 Metadata-Version: 2.4
 Name: heurist-api
-Version: 0.2.1
-Dynamic: Description
-Dynamic: Description-Content-Type
-Summary: API wrapper and CLI for Heurist database.
+Version: 0.2.2a0
+Dynamic: Summary
 Project-URL: Homepage, https://lostma-erc.github.io/heurist-api/
 Project-URL: Documentation, https://lostma-erc.github.io/heurist-api/
 Project-URL: Repository, https://github.com/LostMa-ERC/heurist-api
@@ -465,3 +463,42 @@ Requires-Dist: pymdown-extensions>=10.15; extra == 'dev'
 Requires-Dist: pytest>=8.3.5; extra == 'dev'
 Requires-Dist: ruff>=0.11.10; extra == 'dev'
 Requires-Dist: uv>=0.7.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Heurist API & Data Pipeline
+
+[![Python package](https://github.com/LostMa-ERC/heurist-etl-pipeline/actions/workflows/python-package.yml/badge.svg)](https://github.com/LostMa-ERC/heurist-etl-pipeline/actions/workflows/python-package.yml) [![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC_BY--SA_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
+[![coverage](https://github.com/LostMa-ERC/heurist-etl-pipeline/raw/main/docs/assets/coverage-badge.svg)](https://github.com/LostMa-ERC/heurist-etl-pipeline/raw/main/docs/assets/coverage-badge.svg)
+[![tests](https://github.com/LostMa-ERC/heurist-etl-pipeline/raw/main/docs/assets/tests-badge.svg)](https://github.com/LostMa-ERC/heurist-etl-pipeline/raw/main/docs/assets/tests-badge.svg)
+
+<img src="https://github.com/LostMa-ERC/heurist-etl-pipeline/raw/main/docs/assets/logo-transparent-1.png" style="width:300px" alt="Logo showing heurist on the left, a pipe in the middle, and output formats DuckDB, JavaScript and CSV on the right."/>
+
+Extract, transform, and load data from your Heurist database into local formats. Great for freeing up your data analysis pipeline!
+
+## Quick Start
+
+Install (Python version +3.10) with pip.
+
+```shell
+pip install heurist-api
+```
+
+Download your record types in a [DuckDB](https://duckdb.org/) database file.
+
+```shell
+heurist -d 'YOUR.DATABASE' -u 'YOUR.LOGIN' -p 'YOUR.PASSWORD' download -f 'FILE.DB'
+```
+
+## Full Documentation
+
+For detailed information about installation, usage, etc., navigate to the documentation site below:
+
+- [Documentation](https://lostma-erc.github.io/heurist-api/)
+
+## License
+
+[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC_BY--SA_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
+
+## Funding
+
+The development of this pipeline tool was funded by the European Research Council. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Research Council. Neither the European Union nor the granting authority can be held responsible for them.

{heurist_api-0.2.1.dist-info → heurist_api-0.2.2a0.dist-info}/RECORD

@@ -9,7 +9,7 @@ heurist/api/url_builder.py,sha256=mT1hgZ-T38EPyHCSLfjFecbZVLsiPi18jemDuuMj21I,49
 heurist/api/utils.py,sha256=DT-BrdF7O2lmFSduRYOecx302dAlLWQTYgr2V9JoDYI,643
 heurist/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 heurist/cli/__main__.py,sha256=QG2gJG7zD3YIDRqbIp2MzTqPxqGLZ77RHCRYZ58SSjg,5975
-heurist/cli/load.py,sha256=q6QwZRtIQVoII1HHLW0iGklfXJlHEVxrDwb8UeX7la4,2610
+heurist/cli/load.py,sha256=iiQ11EauKV93Z3YuGyspeOK9XQIVf5SqRzQ9b6V8KZQ,2685
 heurist/cli/parse_log.py,sha256=cZU9mpLbx5p-bdCwbII27T-ugTpecTgCFiBoYJip5f4,828
 heurist/cli/records.py,sha256=yKK3XIZrU1szo6X-HmGjZpD0IKk3a3rd3Kkyrg5AYGE,1345
 heurist/cli/schema.py,sha256=Dg8NcSdI7Xb6r-dkUC_razXlZNtxSG0x7awsr1m8Mcw,2766
@@ -17,7 +17,7 @@ heurist/database/__init__.py,sha256=JvQCGCi84AXUSIPCu4cTOqT_yZGDLmZFAUdsHDLbpKI,
 heurist/database/basedb.py,sha256=0MKfQOKTBDCc6qcl8BGl5OIpSA7SYgmfcKXCBVWBPes,4200
 heurist/database/database.py,sha256=rJPhGA4158eoIwe13QsSGZ8929dkRxMTesRRlMrn1tI,4057
 heurist/log/__init__.py,sha256=ubZl-2yMlvUYJwJtnk6C8AjmnU-9mbp96aHL1NSzbSg,149
-heurist/log/constants.py,sha256=5FaEnyXCEt1gga0pgwq4sfz_dX58BK1NixXQ2CsihNo,117
+heurist/log/constants.py,sha256=8TsR_BxYL_TzZSQWwKAO8oWqBGZ0g3e-XNls5XWymDs,81
 heurist/log/iterator.py,sha256=nmpW3QQfwToADD4zffAm5iFyIUMFT56LRORdThYRoqE,519
 heurist/log/model.py,sha256=rOey1V6Vd_ehm8FTXxfi7Q4A4Mjq0V9ITl_GlNdB0y0,1085
 heurist/log/summary.py,sha256=n-skKRiFSPd3DieZMveJLCP96plVdgjW9wgBR0H_2BI,1113
@@ -54,7 +54,7 @@ heurist/validators/__init__.py,sha256=Im5z_Yg2VdKSZRPUOPSF5AFZ8AWgnyBZNKhy1o69lC
 heurist/validators/detail_validator.py,sha256=NVItrZ4Ysmgqab-B24hIeimGqpiaiqFiono5qwW20ko,4070
 heurist/validators/exceptions.py,sha256=tgoMn6R2CExT6mFg2qe4vRxP2D61cNdgEqc7YUQCFSE,1108
 heurist/validators/parse_heurist_date.py,sha256=S-NzuLZJwDrxRJkAd-fXpOlENlkc8HXKRILWCODmtIU,2161
-heurist/validators/record_validator.py,sha256=37xFdBwfgQY21jCtcm45_8AOu6DwC27AGC4ompykJUE,6265
+heurist/validators/record_validator.py,sha256=2mPfX_57F3MsgVVxpJm6Na2JCGhEicYD2bN_X6fn2L0,6253
 heurist/workflows/__init__.py,sha256=aYN0UE_7rD9h0h74DMXkUTIDrxA0WcsWLEXWK123Gzc,81
 heurist/workflows/etl.py,sha256=IA97B1NOg_2btT_pynY64RYvbL4JraAy6wgIKJlNljM,2286
 mock_data/__init__.py,sha256=TGe3NjGTXVRQbakVGEWbDDzIkFQ72fTZhTcAoIH3DGQ,488
@@ -79,8 +79,8 @@ mock_data/geo/single.py,sha256=gbk_gOLfVlJuU3MhjY2Lu14bs9-FbZmNtevpiw9jArk,79867
 mock_data/resource/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mock_data/resource/repeated.py,sha256=Nf3nIL596pLVbKo20sQm5UITwBzqf-IHFzE_m2UCLbw,788
 mock_data/resource/single.py,sha256=SXVri1MM8UaJw7GejMEJ6seNEnMksdw_WKiOxQOdVFs,411
-heurist_api-0.2.1.dist-info/METADATA,sha256=INf5LbhdDjblw82g0TfLpwSC9E2oIQ4pRPjeme25sb0,25177
-heurist_api-0.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-heurist_api-0.2.1.dist-info/entry_points.txt,sha256=37KBvqofapLaKDPFrcYxv_rfUM9H08Mbe6mxNdd_Xno,93
-heurist_api-0.2.1.dist-info/licenses/LICENSE,sha256=I-54yLrknPCOovDISUXGa5h-vkUgiB-1Gz2tT7Q9B8I,20137
-heurist_api-0.2.1.dist-info/RECORD,,
+heurist_api-0.2.2a0.dist-info/METADATA,sha256=tMQ4GnFCobKMaeh3nZU2GcdnG5-fMilIOBx3ftrrUsU,27241
+heurist_api-0.2.2a0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+heurist_api-0.2.2a0.dist-info/entry_points.txt,sha256=37KBvqofapLaKDPFrcYxv_rfUM9H08Mbe6mxNdd_Xno,93
+heurist_api-0.2.2a0.dist-info/licenses/LICENSE,sha256=I-54yLrknPCOovDISUXGa5h-vkUgiB-1Gz2tT7Q9B8I,20137
+heurist_api-0.2.2a0.dist-info/RECORD,,