Use poetry as the build tool and apply linting & styling (#4)

.flake8

@@ -0,0 +1,12 @@
+[flake8]
+max-line-length = 120
+max-complexity = 10
+select = C,E,F,W,B,B950
+ignore = E211, E999, F401, F821, W503
+exclude =
+    .git,
+    .direnv,
+    .tox,
+    dist
+    *.egg-info,
+    .pytest_cache

.github/workflows/build.yaml

@@ -0,0 +1,35 @@
+name: build and test
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  POETRY_HOME: "/opt/poetry"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: set up python
+        uses: actions/setup-python@v4
+        with:
+          python-version: |
+            3.9
+            3.10
+            3.11
+            3.12
+      - name: install poetry
+        run: |
+          python3 -m venv $POETRY_HOME
+          $POETRY_HOME/bin/pip install poetry==1.7.1
+          $POETRY_HOME/bin/poetry --version
+      - name: add poetry to path
+        run: echo "${POETRY_HOME}/bin" >> $GITHUB_PATH
+      - name: install dependencies and build
+        run: poetry install
+      - name: run tests
+        run: poetry run tox -p

.gitignore

@@ -131,4 +131,7 @@ dmypy.json
 .pyre/
 
 # ide
-.idea/
+.idea/
+
+.direnv
+.envrc

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.7.0
+    hooks:
+      - id: mypy
+        exclude: ^tests/
+        args: [ --strict ]

README.md

@@ -41,6 +41,23 @@ If you don't want requirements on pulling this module from github via
 https, simply vendor a copy of the module into your project. You only
 need the `neo4j_arrow` directory.
 
+# Build
+
+This project uses [poetry]() as the build tool.
+Install `poetry`, define your environment with `poetry env use` and invoke `poetry install` to install dependencies.
+
+To build;
+
+```
+poetry build
+```
+
+To run tests;
+
+```
+poetry run tox
+```
+
 # Usage
 
 The client is designed to be lightweight and lazy. As such, you should

example_models/bigquery_model.json

@@ -38,4 +38,4 @@
       "target_field": "paper"
     }
   ]
-}
+}

example_models/gcs_model.json

@@ -38,4 +38,4 @@
       "target_field": "paper"
     }
   ]
-}
+}

example_models/stackoverflow_model.json

@@ -52,4 +52,4 @@
       }
     }
   ]
-}
+}