TIMX 414 - initial library scaffolding

.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  # Maintain dependencies for npm
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/pull-request-template.md

@@ -0,0 +1,30 @@
+### Purpose and background context
+Describe the overall purpose of the PR changes and any useful background context.
+
+### How can a reviewer manually see the effects of these changes?
+Explain how to see the proposed changes in the application if possible.
+
+Delete this section if it isn't applicable to the PR.
+
+### Includes new or updated dependencies?
+YES | NO
+
+### Changes expectations for external applications?
+YES | NO
+
+### What are the relevant tickets?
+- Include links to Jira Software and/or Jira Service Management tickets here.
+
+### Developer
+- [ ] All new ENV is documented in README
+- [ ] All new ENV has been added to staging and production environments
+- [ ] All related Jira tickets are linked in commit message(s)
+- [ ] Stakeholder approval has been confirmed (or is not needed)
+
+### Code Reviewer(s)
+- [ ] The commit message is clear and follows our guidelines (not just this PR message)
+- [ ] There are appropriate tests covering any new functionality
+- [ ] The provided documentation is sufficient for understanding any new functionality introduced
+- [ ] Any manual tests have been performed **or** provided examples verified
+- [ ] New dependencies are appropriate or there were no changes
+

.github/workflows/ci.yml

@@ -0,0 +1,7 @@
+name: CI
+on: push
+jobs:
+  test:
+    uses: mitlibraries/.github/.github/workflows/python-shared-test.yml@main
+  lint:
+    uses: mitlibraries/.github/.github/workflows/python-shared-lint.yml@main

.gitignore

@@ -155,8 +155,4 @@ dmypy.json
 cython_debug/
 
 # PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+default_language_version:
+  python: python3.12
+repos:
+  - repo: local
+    hooks:
+      - id: black-apply
+        name: black-apply
+        entry: pipenv run black
+        language: system
+        pass_filenames: true
+        types: ["python"]
+      - id: mypy
+        name: mypy
+        entry: pipenv run mypy
+        language: system
+        pass_filenames: true
+        types: ["python"]
+        exclude: "tests/"
+      - id: ruff-apply
+        name: ruff-apply
+        entry: pipenv run ruff check --fix
+        language: system
+        pass_filenames: true
+        types: ["python"]
+      - id: safety
+        name: safety
+        entry: pipenv check
+        language: system
+        pass_filenames: false

.python-version

@@ -0,0 +1 @@
+3.12

Makefile

@@ -0,0 +1,56 @@
+SHELL=/bin/bash
+DATETIME:=$(shell date -u +%Y%m%dT%H%M%SZ)
+
+help: # Preview Makefile commands
+	@awk 'BEGIN { FS = ":.*#"; print "Usage:  make <target>\n\nTargets:" } \
+/^[-_[:alpha:]]+:.?*#/ { printf "  %-15s%s\n", $$1, $$2 }' $(MAKEFILE_LIST)
+
+#######################
+# Dependency commands
+#######################
+
+install: # Install Python dependencies
+	pipenv install --dev
+	pipenv run pre-commit install
+
+update: install # Update Python dependencies
+	pipenv clean
+	pipenv update --dev
+
+######################
+# Unit test commands
+######################
+
+test: # Run tests and print a coverage report
+	pipenv run coverage run --source=timdex_dataset_api -m pytest -vv
+	pipenv run coverage report -m
+
+coveralls: test # Write coverage data to an LCOV report
+	pipenv run coverage lcov -o ./coverage/lcov.info
+
+####################################
+# Code quality and safety commands
+####################################
+
+lint: black mypy ruff safety # Run linters
+
+black: # Run 'black' linter and print a preview of suggested changes
+	pipenv run black --check --diff .
+
+mypy: # Run 'mypy' linter
+	pipenv run mypy .
+
+ruff: # Run 'ruff' linter and print a preview of errors
+	pipenv run ruff check .
+
+safety: # Check for security vulnerabilities and verify Pipfile.lock is up-to-date
+	pipenv check
+	pipenv verify
+
+lint-apply: black-apply ruff-apply # Apply changes with 'black' and resolve 'fixable errors' with 'ruff'
+
+black-apply: # Apply changes with 'black'
+	pipenv run black .
+
+ruff-apply: # Resolve 'fixable errors' with 'ruff'
+	pipenv run ruff check --fix .

Pipfile

@@ -0,0 +1,26 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+boto3 = "*"
+duckdb = "*"
+pandas = "*"
+pyarrow = "*"
+
+[dev-packages]
+black = "*"
+boto3-stubs = {version = "*", extras = ["s3"]}
+coveralls = "*"
+ipython = "*"
+mypy = "*"
+pre-commit = "*"
+pyarrow-stubs = "*"
+pytest = "*"
+ruff = "*"
+setuptools = "*"
+pandas-stubs = "*"
+
+[requires]
+python_version = "3.12"