TIMX 414 - initial library scaffolding

[ghukill]

Purpose and background context

This PR scaffolds the project as an installable python library. Very little beyond that at this point.

The repository is called timdex-dataset-api (dashes), but the importable library that is installed is timdex_dataset_api to be fully python compliant.

This library will be used by Transmogrifier, pipeline lambdas, and TIM when interacting with the TIMDEX parquet dataset in S3. Other contexts for usage may emerge, but these are known at this time.

This library will support basic operations like:

• loading a dataset
• writing to a dataset
• reading from a dataset

For more details on why a standalone python library, please see associated parent ticket: https://mitlibraries.atlassian.net/browse/TIMX-408.

How can a reviewer manually see the effects of these changes?

Local development of library

Clone repo, then normal things, make test and make lint.

Install as library for another project

1- create a new, temporary python project

cd /tmp
mkdir my-app
cd my-app
pipenv install --python 3.12

2- install library from github via this PR's commit

pipenv install git+https://github.com/MITLibraries/timdex-dataset-api.git@fd64746

Note the Pipfile will contain something like this:

[packages]
timdex-dataset-api = {ref = "fd64746", git = "git+https://github.com/MITLibraries/timdex-dataset-api.git"}

This demonstrates two things:

1. the library is installable directly from Github
2. we can install a particular version via a commit SHA, release tag, etc.

3- open Ipython shell and confirm importable

pipenv run ipython

from timdex_dataset_api import __version__

print(__version__)
# '0.1.0'

This demonstrates that the version number in the pyproject.toml --> project.version section is what sets the version when installed.

Includes new or updated dependencies?

YES

Changes expectations for external applications?

NO

What are the relevant tickets?

• https://mitlibraries.atlassian.net/browse/TIMX-414

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

[ehanson8]

Looks good!

[jonavellecuerdo]

Looking good! I just have two minor change requests. 🤓