hdx-python-database 1.3.0__tar.gz → 1.3.2__tar.gz

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/.config/pre-commit-config.yaml

@@ -1,14 +1,14 @@
 default_language_version:
-    python: python3.11
+    python: python3.12
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-ast
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.14
+    rev: v0.5.6
     hooks:
       # Run the linter.
       - id: ruff
@@ -16,10 +16,11 @@ repos:
       # Run the formatter.
       - id: ruff-format
         args: [--config, .config/ruff.toml]
-  - repo: https://github.com/jazzband/pip-tools
-    rev: 7.3.0
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.2.33
     hooks:
+      # Run the pip compile
       - id: pip-compile
         name: pip-compile requirements.txt
         files: pyproject.toml
-        args: [pyproject.toml, --resolver=backtracking, --all-extras, --upgrade, -q, -o, requirements.txt]
+        args: [ pyproject.toml, --resolver=backtracking, --all-extras, --upgrade, -q, -o, requirements.txt ]

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/.github/workflows/publish.yaml

@@ -9,19 +9,20 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Get history and tags for versioning to work
       run: |
         git fetch --prune --unshallow
         git fetch --depth=1 origin +refs/tags/*:refs/tags/*
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install --upgrade hatch
+    - name: Install Hatch
+      uses: pypa/hatch@install
     - name: Build with hatch
       run: |
         hatch build

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/.github/workflows/run-python-tests.yaml

@@ -18,22 +18,23 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install --upgrade hatch
+    - name: Install Hatch
+      uses: pypa/hatch@install
     - name: Test with hatch/pytest
       run: |
-        hatch run test:test
+        hatch test
     - name: Check styling
       if: always()
       run: |
-        hatch run lint:style
+        hatch fmt --check
     - name: Publish Unit Test Results
       uses: EnricoMi/publish-unit-test-result-action@v2
       if: always()

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: hdx-python-database
-Version: 1.3.0
+Version: 1.3.2
 Summary: HDX Python database utilities
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-database
 Author-email: Michael Rans <rans@email.com>
@@ -39,8 +39,7 @@ Description-Content-Type: text/markdown
 
 [![Build Status](https://github.com/OCHA-DAP/hdx-python-database/actions/workflows/run-python-tests.yaml/badge.svg)](https://github.com/OCHA-DAP/hdx-python-database/actions/workflows/run-python-tests.yaml)
 [![Coverage Status](https://coveralls.io/repos/github/OCHA-DAP/hdx-python-database/badge.svg?branch=main&ts=1)](https://coveralls.io/github/OCHA-DAP/hdx-python-database?branch=main)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Downloads](https://img.shields.io/pypi/dm/hdx-python-database.svg)](https://pypistats.org/packages/hdx-python-database)
 
 The HDX Python Database Library provides utilities for connecting to databases in a standard way including

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/README.md

@@ -1,7 +1,6 @@
 [![Build Status](https://github.com/OCHA-DAP/hdx-python-database/actions/workflows/run-python-tests.yaml/badge.svg)](https://github.com/OCHA-DAP/hdx-python-database/actions/workflows/run-python-tests.yaml)
 [![Coverage Status](https://coveralls.io/repos/github/OCHA-DAP/hdx-python-database/badge.svg?branch=main&ts=1)](https://coveralls.io/github/OCHA-DAP/hdx-python-database?branch=main)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Downloads](https://img.shields.io/pypi/dm/hdx-python-database.svg)](https://pypistats.org/packages/hdx-python-database)
 
 The HDX Python Database Library provides utilities for connecting to databases in a standard way including

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/documentation/.readthedocs.yaml

@@ -11,5 +11,6 @@ build:
   jobs:
     pre_build:
       - pip install --upgrade mkdocs
+      - pip install mkdocs-material
       - pip install pydoc-markdown
       - pydoc-markdown documentation/pydoc-markdown.yaml

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/documentation/main.md

@@ -22,6 +22,13 @@ installed with extra `postgresql`:
     pip install hdx-python-database[postgresql]
 
 ## Breaking changes
+From 1.3.1, Database class refactored. With returns Database not Session
+object and can accept a prepare function called before
+Base.metadata.create_all. get_session can be used to obtain the session.
+get_engine, get_reflected_classes, get_prepare_results methods added.
+build_view, build_views move into Database class and renamed prepare_view and
+prepare_views.
+
 From 1.2.8, the sshtunnel dependency is optional.
 
 From 1.2.7, default table names are no longer plural. The camel case class name
@@ -51,8 +58,13 @@ Versions from 1.0.6 no longer support Python 2.7.
 
 ## Database
 
+A fresh schema can be created using the function `recreate_schema`. Any
+existing schema with that name will be dropped eg.
+
+    Database.recreate_schema(engine, db_uri)
+
 Your SQLAlchemy database tables must inherit from `Base` in
-`hdx.database.no_timezone` or `hdx.database.with_timezone` eg. :
+`hdx.database.no_timezone` or `hdx.database.with_timezone` eg.
 
     from hdx.database.no_timezone import Base
     class MyTable(Base):
@@ -70,9 +82,14 @@ tunnel (which requires installing `hdx-python-database[sshtunnel]`):
     from hdx.database import Database
     with Database(database="db", host="1.2.3.4", username="user",
                   password="pass", dialect="dialect", driver="driver",
+
                   ssh_host="5.6.7.8", ssh_port=2222, ssh_username="sshuser",
                   ssh_private_key="path_to_key", db_has_tz=True,
-                  reflect=False) as session:
+                  reflect=True, prepare_fn=prepare_views) as database:
+        engine = database.get_engine()
+        session = database.get_session()
+        reflected_classes = database.get_reflected_classes()
+        views = database.get_prepare_results()
         session.query(...)
 
 `db_has_tz` which defaults to `False` indicates whether database datetime
@@ -83,11 +100,24 @@ between Python datetimes with timezones to timezoneless database columns.
 
 If `reflect` (which defaults to `False`) is `True`, classes will be reflected
 from an existing database and the reflected classes are returned in a variable
-`reflected_classes` in the returned Session object. Note that type annotation
+`reflected_classes` in the Database object. Note that type annotation
 maps don't work with reflection and hence `db_has_tz` will be ignored ie.
 there will be no conversion between Python datetimes with timezones to
 timezoneless database columns.
 
+A PostgreSQL database can be restored from a file generated by the `pg_dump`
+command line utility by supplying `pg_restore_file` with the path to the file
+to be restored.
+
+There is an option to wipe and create an empty schema in the database by
+setting `recreate_schema` to `True` and setting a `schema_name` ("public" is
+the default).
+
+If a prepare function is supplied in prepare_fn, it will be executed before
+Base.metadata.create_all and the results of it returned in instance variable
+prepare_results.
+
+
 ## Connection URI
 
 There are functions to handle converting from connection URIs to parameters and
@@ -117,10 +147,9 @@ URI that contains both dialect and driver.
 
 ## Views
 
-The method to make views described [here](https://github.com/sqlalchemy/sqlalchemy/wiki/Views#sqlalchemy-14-20-version)
-is available in this library.
+The method to prepare views described [here](https://github.com/sqlalchemy/sqlalchemy/wiki/Views#sqlalchemy-14-20-version) is available in this library.
 
-This allows creating views like this:
+This allows preparing views like this:
 ```
 class DBOrgType(Base):
     __tablename__ = "org_type"
@@ -144,16 +173,25 @@ date_view_params = {
     "selectable": select(*DBTestDate.__table__.columns),
 }
 
-date_view = build_view(date_view_params)
+date_view = Database.prepare_view(date_view_params)
 
-date_view = build_views([date_view_params])[0]
+date_view = Database.prepare_views([date_view_params])[0]
 ```
 
+View preparation must be done before calling Base.metadata.create_all.
+
 ## PostgreSQL specific
 
-There is a PostgreSQL specific call that only returns when the PostgreSQL database
-is available:
+There is a PostgreSQL specific call that only returns when the PostgreSQL
+database becomes available:
 
     # Wait until PostgreSQL is up
     # Library should be installed with hdx-python-database[postgresql]
-    wait_for_postgresql("mydatabase", "myserver", 5432, "myuser", "mypass")
+    db_uri = "postgresql+psycopg://myuser:mypass@1.2.3.4:12345/mydatabase"
+    wait_for_postgresql(db_uri)
+
+The database can be restored from a file generated by `pg_dump` like this:
+
+    db_uri = "postgresql+psycopg://myuser:mypass@1.2.3.4:12345/mydatabase"
+    pg_restore_file = "backup.pg_restore"
+    assert restore_from_pgfile(db_uri, pg_restore_file) == "WORKED!"

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/documentation/pydoc-markdown.yaml

@@ -9,7 +9,7 @@ renderer:
   output_directory: docs
   mkdocs_config:
     site_name: HDX Python Database
-    theme: mkdocs
+    theme: material
     repo_url: "https://github.com/OCHA-DAP/hdx-python-database"
   markdown:
     source_linker:

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/pyproject.toml

@@ -75,25 +75,21 @@ version_scheme = "python-simplified-semver"
 
 # Tests
 
-[tool.hatch.envs.test]
+[tool.hatch.envs.hatch-test]
 features = ["sshtunnel", "postgresql", "test"]
 
-[tool.hatch.envs.test.scripts]
-test = """
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["3.12"]
+
+[tool.hatch.envs.hatch-test.scripts]
+run = """
        pytest -c .config/pytest.ini --rootdir=. --junitxml=test-results.xml \
        --cov --cov-config=.config/coveragerc --no-cov-on-fail \
-       --cov-report=lcov --cov-report=term-missing
+       --cov-report=lcov --cov-report=term-missing -p no:randomly
        """
 
-[[tool.hatch.envs.test.matrix]]
-python = ["3.12"]
-
-[tool.hatch.envs.lint]
-detached = true
-dependencies = ["ruff"]
-
-[tool.hatch.envs.lint.scripts]
-style = [
-  "ruff check --config .config/ruff.toml --diff {args:.}",
-  "ruff format --config .config/ruff.toml --diff {args:.}",
-]
+[tool.hatch.envs.hatch-static-analysis.scripts]
+format-check = ["ruff format --config .config/ruff.toml --check --diff {args:.}",]
+format-fix = ["ruff format --config .config/ruff.toml {args:.}",]
+lint-check = ["ruff check --config .config/ruff.toml {args:.}",]
+lint-fix = ["ruff check --config .config/ruff.toml --fix {args:.}",]

{hdx_python_database-1.3.0 → hdx_python_database-1.3.2}/requirements.txt

@@ -1,69 +1,62 @@
-#
-# This file is autogenerated by pip-compile with Python 3.11
-# by the following command:
-#
-#    pip-compile --all-extras --output-file=requirements.txt --resolver=backtracking pyproject.toml
-#
-bcrypt==4.1.2
+# This file was autogenerated by uv via the following command:
+#    uv pip compile pyproject.toml --resolver=backtracking --all-extras -o requirements.txt
+bcrypt==4.2.0
     # via paramiko
-cffi==1.16.0
+cffi==1.17.0
     # via
     #   cryptography
     #   pynacl
 cfgv==3.4.0
     # via pre-commit
-coverage[toml]==7.4.1
+coverage==7.6.1
     # via pytest-cov
-cryptography==42.0.2
+cryptography==43.0.0
     # via paramiko
 distlib==0.3.8
     # via virtualenv
-filelock==3.13.1
+filelock==3.15.4
     # via virtualenv
 greenlet==3.0.3
     # via sqlalchemy
-identify==2.5.34
+identify==2.6.0
     # via pre-commit
 iniconfig==2.0.0
     # via pytest
-nodeenv==1.8.0
+nodeenv==1.9.1
     # via pre-commit
-packaging==23.2
+packaging==24.1
     # via pytest
 paramiko==3.4.0
     # via sshtunnel
-platformdirs==4.2.0
+platformdirs==4.2.2
     # via virtualenv
-pluggy==1.4.0
+pluggy==1.5.0
     # via pytest
-pre-commit==3.6.1
+pre-commit==3.8.0
     # via hdx-python-database (pyproject.toml)
-psycopg[binary]==3.1.18
+psycopg==3.2.1
     # via hdx-python-database (pyproject.toml)
-psycopg-binary==3.1.18
+psycopg-binary==3.2.1
     # via psycopg
-pycparser==2.21
+pycparser==2.22
     # via cffi
 pynacl==1.5.0
     # via paramiko
-pytest==8.0.0
+pytest==8.3.2
     # via
     #   hdx-python-database (pyproject.toml)
     #   pytest-cov
-pytest-cov==4.1.0
+pytest-cov==5.0.0
     # via hdx-python-database (pyproject.toml)
-pyyaml==6.0.1
+pyyaml==6.0.2
     # via pre-commit
-sqlalchemy==2.0.27
+sqlalchemy==2.0.32
     # via hdx-python-database (pyproject.toml)
 sshtunnel==0.4.0
     # via hdx-python-database (pyproject.toml)
-typing-extensions==4.9.0
+typing-extensions==4.12.2
     # via
     #   psycopg
     #   sqlalchemy
-virtualenv==20.25.0
+virtualenv==20.26.3
     # via pre-commit
-
-# The following packages are considered to be unsafe in a requirements file:
-# setuptools