heurist-api 0.2.2__tar.gz → 0.2.2a0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of heurist-api might be problematic. Click here for more details.

Files changed (130) hide show
  1. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/PKG-INFO +41 -4
  2. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/pyproject.toml +3 -3
  3. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/uv.lock +1 -1
  4. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/.github/workflows/pypi-release.yml +0 -0
  5. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/.github/workflows/python-package.yml +0 -0
  6. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/.gitignore +0 -0
  7. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/.pre-commit-config.yaml +0 -0
  8. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/LICENSE +0 -0
  9. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/README.md +0 -0
  10. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/demos/pandas_dataframe.ipynb +0 -0
  11. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/assets/coverage-badge.svg +0 -0
  12. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/assets/erc-logo.png +0 -0
  13. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/assets/heurist-admin-panel-users.png +0 -0
  14. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/assets/logo-transparent-1.png +0 -0
  15. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/assets/logo-transparent.png +0 -0
  16. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/assets/logo.png +0 -0
  17. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/assets/tests-badge.svg +0 -0
  18. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/development/code_of_conduct.md +0 -0
  19. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/development/contributing.md +0 -0
  20. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/development/coverage.md +0 -0
  21. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/development/heuristdb/temporal.md +0 -0
  22. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/development/publishing.md +0 -0
  23. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/index.md +0 -0
  24. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/legal.md +0 -0
  25. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/download/date_validation.md +0 -0
  26. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/download/export_csv.md +0 -0
  27. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/download/group_types.md +0 -0
  28. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/download/index.md +0 -0
  29. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/download/logs.md +0 -0
  30. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/download/user_filter.md +0 -0
  31. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/index.md +0 -0
  32. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/module.md +0 -0
  33. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/records.md +0 -0
  34. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/rstudio.md +0 -0
  35. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/usage/schema.md +0 -0
  36. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/mkdocs.yml +0 -0
  37. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/__init__.py +0 -0
  38. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/api/__init__.py +0 -0
  39. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/api/client.py +0 -0
  40. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/api/connection.py +0 -0
  41. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/api/constants.py +0 -0
  42. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/api/credentials.py +0 -0
  43. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/api/exceptions.py +0 -0
  44. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/api/url_builder.py +0 -0
  45. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/api/utils.py +0 -0
  46. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/cli/__init__.py +0 -0
  47. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/cli/__main__.py +0 -0
  48. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/cli/load.py +0 -0
  49. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/cli/parse_log.py +0 -0
  50. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/cli/records.py +0 -0
  51. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/cli/schema.py +0 -0
  52. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/database/__init__.py +0 -0
  53. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/database/basedb.py +0 -0
  54. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/database/database.py +0 -0
  55. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/log/__init__.py +0 -0
  56. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/log/constants.py +0 -0
  57. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/log/iterator.py +0 -0
  58. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/log/model.py +0 -0
  59. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/log/summary.py +0 -0
  60. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/__init__.py +0 -0
  61. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/dynamic/__init__.py +0 -0
  62. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/dynamic/annotation.py +0 -0
  63. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/dynamic/create_model.py +0 -0
  64. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/dynamic/date.py +0 -0
  65. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/dynamic/type.py +0 -0
  66. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/DetailTypes.py +0 -0
  67. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/RecStructure.py +0 -0
  68. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/RecTypeGroups.py +0 -0
  69. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/RecTypes.py +0 -0
  70. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/Terms.py +0 -0
  71. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/__init__.py +0 -0
  72. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/dty.py +0 -0
  73. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/hml_structure.py +0 -0
  74. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/rst.py +0 -0
  75. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/rtg.py +0 -0
  76. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/rty.py +0 -0
  77. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/trm.py +0 -0
  78. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/models/structural/utils.py +0 -0
  79. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/schema/__init__.py +0 -0
  80. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/schema/models.py +0 -0
  81. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/schema/rel_to_dict.py +0 -0
  82. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/sql/__init__.py +0 -0
  83. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/sql/joinRecordTypeIDNameByGroupType.sql +0 -0
  84. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/sql/joinRecordTypeMetadata.sql +0 -0
  85. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/sql/selectRecordTypeSchema.sql +0 -0
  86. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/sql/sql_safety.py +0 -0
  87. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/utils/constants.py +0 -0
  88. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/utils/rel_to_dict_array.py +0 -0
  89. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/validators/__init__.py +0 -0
  90. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/validators/detail_validator.py +0 -0
  91. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/validators/exceptions.py +0 -0
  92. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/validators/parse_heurist_date.py +0 -0
  93. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/validators/record_validator.py +0 -0
  94. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/workflows/__init__.py +0 -0
  95. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/heurist/workflows/etl.py +0 -0
  96. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/__init__.py +0 -0
  97. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/blocktext/__init__.py +0 -0
  98. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/blocktext/single.py +0 -0
  99. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/date/__init__.py +0 -0
  100. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/date/compound_repeated.py +0 -0
  101. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/date/compound_single.py +0 -0
  102. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/date/simple_single.py +0 -0
  103. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/date/timestamp_repeated.py +0 -0
  104. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/enum/__init__.py +0 -0
  105. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/enum/repeated.py +0 -0
  106. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/enum/single.py +0 -0
  107. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/file/__init__.py +0 -0
  108. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/file/single.py +0 -0
  109. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/float/__init__.py +0 -0
  110. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/float/single.py +0 -0
  111. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/freetext/__init__.py +0 -0
  112. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/freetext/single.py +0 -0
  113. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/geo/__init__.py +0 -0
  114. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/geo/single.py +0 -0
  115. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/resource/__init__.py +0 -0
  116. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/resource/repeated.py +0 -0
  117. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/mock_data/resource/single.py +0 -0
  118. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/scripts/gen_badges.sh +0 -0
  119. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/src/scripts/gen_ref_pages.py +0 -0
  120. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/e2e/download_test.py +0 -0
  121. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/e2e/schema_test.py +0 -0
  122. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/integration/api/client_test.py +0 -0
  123. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/integration/api/connection_test.py +0 -0
  124. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/unit/database/database_test.py +0 -0
  125. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/unit/database/modeling_test.py +0 -0
  126. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/unit/database/skeleton_test.py +0 -0
  127. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/unit/log_test.py +0 -0
  128. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/unit/schema/get_db_schema_test.py +0 -0
  129. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/unit/validators/detail_validation_test.py +0 -0
  130. {heurist_api-0.2.2 → heurist_api-0.2.2a0}/tests/unit/validators/repeated_enum_test.py +0 -0
{heurist_api-0.2.2 → heurist_api-0.2.2a0}/PKG-INFO RENAMED
@@ -1,9 +1,7 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: heurist-api
3
- Version: 0.2.2
4
- Dynamic: Description
5
- Dynamic: Description-Content-Type
6
- Summary: API wrapper and CLI for Heurist database.
3
+ Version: 0.2.2a0
4
+ Dynamic: Summary
7
5
  Project-URL: Homepage, https://lostma-erc.github.io/heurist-api/
8
6
  Project-URL: Documentation, https://lostma-erc.github.io/heurist-api/
9
7
  Project-URL: Repository, https://github.com/LostMa-ERC/heurist-api
@@ -465,3 +463,42 @@ Requires-Dist: pymdown-extensions>=10.15; extra == 'dev'
465
463
  Requires-Dist: pytest>=8.3.5; extra == 'dev'
466
464
  Requires-Dist: ruff>=0.11.10; extra == 'dev'
467
465
  Requires-Dist: uv>=0.7.5; extra == 'dev'
466
+ Description-Content-Type: text/markdown
467
+
468
+ # Heurist API & Data Pipeline
469
+
470
+ [![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/)
471
+ [![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)
472
+ [![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)
473
+
474
+ <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."/>
475
+
476
+ Extract, transform, and load data from your Heurist database into local formats. Great for freeing up your data analysis pipeline!
477
+
478
+ ## Quick Start
479
+
480
+ Install (Python version +3.10) with pip.
481
+
482
+ ```shell
483
+ pip install heurist-api
484
+ ```
485
+
486
+ Download your record types in a [DuckDB](https://duckdb.org/) database file.
487
+
488
+ ```shell
489
+ heurist -d 'YOUR.DATABASE' -u 'YOUR.LOGIN' -p 'YOUR.PASSWORD' download -f 'FILE.DB'
490
+ ```
491
+
492
+ ## Full Documentation
493
+
494
+ For detailed information about installation, usage, etc., navigate to the documentation site below:
495
+
496
+ - [Documentation](https://lostma-erc.github.io/heurist-api/)
497
+
498
+ ## License
499
+
500
+ [![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/)
501
+
502
+ ## Funding
503
+
504
+ 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.2 → heurist_api-0.2.2a0}/pyproject.toml RENAMED
@@ -1,9 +1,9 @@
1
1
  [project]
2
2
  name = "heurist-api"
3
- version = "0.2.2"
4
- description = "API wrapper and CLI for Heurist database."
3
+ version = "0.2.2a0"
5
4
  keywords = [ "duckdb", "etl" ]
6
- dynamic = [ "readme" ]
5
+ readme = "README.md"
6
+ dynamic = ["description"]
7
7
  license = { file = "LICENSE" }
8
8
  authors = [
9
9
  {name = "Kelly Christensen", email = "kelly.christensen@chartes.psl.eu"}
{heurist_api-0.2.2 → heurist_api-0.2.2a0}/uv.lock RENAMED
@@ -421,7 +421,7 @@ wheels = [
421
421
 
422
422
  [[package]]
423
423
  name = "heurist-api"
424
- version = "0.2.2"
424
+ version = "0.2.2a0"
425
425
  source = { editable = "." }
426
426
  dependencies = [
427
427
  { name = "click" },
{heurist_api-0.2.2 → heurist_api-0.2.2a0}/.gitignore RENAMED
File without changes
{heurist_api-0.2.2 → heurist_api-0.2.2a0}/LICENSE RENAMED
File without changes
{heurist_api-0.2.2 → heurist_api-0.2.2a0}/README.md RENAMED
File without changes
{heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/index.md RENAMED
File without changes
{heurist_api-0.2.2 → heurist_api-0.2.2a0}/docs/legal.md RENAMED
File without changes
{heurist_api-0.2.2 → heurist_api-0.2.2a0}/mkdocs.yml RENAMED
File without changes