heurist-api 0.1.2__tar.gz → 0.1.4__tar.gz

heurist_api-0.1.4/.github/workflows/pypi-release.yml

@@ -0,0 +1,47 @@
+name: Release
+
+on:
+    push:
+        tags:
+          - 'v*'
+
+jobs:
+  # Check that everything works as expected
+  test:
+    name: Tests
+    uses: ./.github/workflows/python-package.yml
+
+  pypi:
+    name: Publish to PyPI
+    needs: test
+    runs-on: ubuntu-latest
+    # Environment and permissions for trusted publishing
+    environment:
+     # This environment was creatd in the GitHub repository under Settings -> Environments
+     # And it's been added as a trusted publisher for the project on PyPI
+     name: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+      - run: uv build
+      - run: uv publish --trusted-publishing always
+
+  # test-pypi:
+  #   name: Publish to Test PyPI
+  #   needs: test
+  #   runs-on: ubuntu-latest
+  #   # Environment and permissions trusted publishing.
+  #   environment:
+  #     # This environment was creatd in the GitHub repository under Settings -> Environments
+  #     # And it's been added as a trusted publisher for the project on TestPyPI
+  #     name: testpypi
+  #   permissions:
+  #     id-token: write
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - uses: astral-sh/setup-uv@v3
+  #     - run: uv build
+  #     - run: uv publish --index testpypi dist/*
+  #     # - run: uv publish --trusted-publishing always

{heurist_api-0.1.2 → heurist_api-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: heurist-api
-Version: 0.1.2
+Version: 0.1.4
 Dynamic: Description
 Dynamic: Description-Content-Type
 Summary: API wrapper and CLI for Heurist database.
@@ -451,3 +451,17 @@ Requires-Dist: python-dotenv>=1.1.0
 Requires-Dist: requests>=2.32.3
 Requires-Dist: rich>=14.0.0
 Requires-Dist: tenacity>=9.1.2
+Provides-Extra: dev
+Requires-Dist: coverage>=7.8.0; extra == 'dev'
+Requires-Dist: genbadge[coverage]>=1.1.2; extra == 'dev'
+Requires-Dist: isort>=6.0.1; extra == 'dev'
+Requires-Dist: mkdocs-gen-files>=0.5.0; extra == 'dev'
+Requires-Dist: mkdocs-literate-nav>=0.6.2; extra == 'dev'
+Requires-Dist: mkdocs-material[imaging]>=9.6.14; extra == 'dev'
+Requires-Dist: mkdocs>=1.6.1; extra == 'dev'
+Requires-Dist: mkdocstrings-python>=1.16.10; extra == 'dev'
+Requires-Dist: pre-commit>=4.2.0; extra == 'dev'
+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'

{heurist_api-0.1.2 → heurist_api-0.1.4}/README.md

@@ -8,11 +8,25 @@
 
 Extract, transform, and load data from your Heurist database into local formats. Great for freeing up your data analysis pipeline!
 
-## Documentation
+## Quick Start
 
-For information about installation, usage, etc., navigate to the documentation site below:
+Install (Python version +3.10) with pip.
 
-- [Documentation](https://lostma-erc.github.io/heurist-etl-pipeline/)
+```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
 

{heurist_api-0.1.2 → heurist_api-0.1.4}/docs/index.md

@@ -1,10 +1,10 @@
-# Heurist ETL
+# Heurist API
 
 [![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)
 
-This Python package Extracts, Transforms, and Loads (ETL) data from a Heurist database server into a local [DuckDB](https://duckdb.org) database file.
+This Python package provides an API wrapper for Heurist as well as a command-line interface (CLI) that Extracts, Transforms, and Loads (ETL) data from a Heurist database server into a local [DuckDB](https://duckdb.org) database file.
 
 - [Installation & configuration](usage/index.md#installation)
 - [Basic command-line usage](usage/index.md#cli-commands)
@@ -14,10 +14,7 @@ This Python package Extracts, Transforms, and Loads (ETL) data from a Heurist da
 [![Logo](https://github.com/LostMa-ERC/heurist-etl-pipeline/raw/main/docs/assets/logo-transparent-1.png)](https://github.com/LostMa-ERC/heurist-etl-pipeline/raw/main/docs/assets/logo-transparent-1.png)
 
 ```shell
-$ pip install \
---index-url https://test.pypi.org/simple/ \
---extra-index-url https://pypi.org/simple \
-heurist
+$ pip install heurist-api
 ```
 
 ## Commands

{heurist_api-0.1.2 → heurist_api-0.1.4}/docs/usage/index.md

@@ -9,7 +9,7 @@ Secondarily, you can also exploit certain modules, such as the API client, for y
 ### Requirements
 
 - Python version 3.10 or greater
-- Virtual Python environment, i.e. [`pyenv`](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation).
+- A way to manage your virtual Python environment, i.e. [`pyenv`](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation).
 
 ### Steps
 
@@ -17,14 +17,11 @@ Secondarily, you can also exploit certain modules, such as the API client, for y
     - Need help installing Python? Check out the [Real Python](https://realpython.com/installing-python/) blog's tutorial.
 2. Create a new virtual environment for the package. Then activate it.
     - What's the simplest way? Check out [Real Python](https://realpython.com/python-virtual-environments-a-primer/)'s thorough blog post.
-    - I recommend naming the environment `heurist`.
-3. Use `pip install` to install the `heurist` Python package.
+    - I recommend naming the environment `heurist-api`.
+3. Use `pip install` to install the `heurist-api` Python package.
 
 ```console
-$ pip install \
---index-url https://test.pypi.org/simple/ \
---extra-index-url https://pypi.org/simple \
-heurist
+$ pip install heurist-api
 ```
 
 ## Configure the CLI

{heurist_api-0.1.2 → heurist_api-0.1.4}/mkdocs.yml

@@ -1,4 +1,4 @@
-site_name: Heurist ETL
+site_name: Heurist API
 site_url: https://lostma-erc.github.io/heurist-api/
 
 theme:

{heurist_api-0.1.2 → heurist_api-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "heurist-api"
-version = "0.1.2"
+version = "0.1.4"
 description = "API wrapper and CLI for Heurist database."
 keywords = [ "duckdb", "etl" ]
 dynamic = [ "readme" ]
@@ -37,7 +37,7 @@ build-backend = "hatchling.build"
 [tool.hatch.build.targets.wheel]
     packages = ["src/heurist", "src/mock_data"]
 
-[dependency-groups]
+[project.optional-dependencies]
 dev = [
     "coverage>=7.8.0",
     "genbadge[coverage]>=1.1.2",

{heurist_api-0.1.2 → heurist_api-0.1.4}/src/heurist/database/database.py

@@ -20,6 +20,8 @@ class TransformedDatabase(HeuristDatabase):
     ) -> None:
         super().__init__(hml_xml, conn, db)
 
+        self.conn.execute("SET GLOBAL pandas_analyze_sample=100000")
+
         # Create an empty index of targeted record types' Pydantic models
         self.pydantic_models = {}
 

{heurist_api-0.1.2 → heurist_api-0.1.4}/uv.lock

@@ -421,7 +421,7 @@ wheels = [
 
 [[package]]
 name = "heurist-api"
-version = "0.1.2"
+version = "0.1.3"
 source = { editable = "." }
 dependencies = [
     { name = "click" },

heurist_api-0.1.2/.github/workflows/pypi-release.yml

@@ -1,33 +0,0 @@
-name: Release
-
-on:
-    push:
-        paths:
-          - '.github/workflows/pypi-release.yml'
-        tags:
-          - 'v*'
-    workflow_call:
-
-jobs:
-  # Check that everything works as expected
-  test:
-    name: Tests
-    uses: ./.github/workflows/python-package.yml
-
-  test-pypi:
-    name: Publish to Test PyPI
-    needs: test
-    runs-on: ubuntu-latest
-    # Environment and permissions trusted publishing.
-    environment:
-      # This environment was creatd in the GitHub repository under Settings -> Environments
-      # And it's been added as a trusted publisher for the project on TestPyPI
-      name: testpypi
-    permissions:
-      id-token: write
-    steps:
-      - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v3
-      - run: uv build
-      - run: uv publish --index testpypi dist/*
-      # - run: uv publish --trusted-publishing always