Skip to content

USE 531 - Refactor data types into folder#188

Merged
ghukill merged 1 commit into
mainfrom
USE-531-fulltext-data-type
May 18, 2026
Merged

USE 531 - Refactor data types into folder#188
ghukill merged 1 commit into
mainfrom
USE-531-fulltext-data-type

Conversation

@ghukill
Copy link
Copy Markdown
Contributor

@ghukill ghukill commented May 18, 2026

Purpose and background context

Small PR to refactor records.py and embeddings.py into new data_types/ folder:

├── data_types
│   ├── __init__.py
│   ├── embeddings.py
│   └── records.py

Allows for imports like:

from timdex_dataset_api.data_types import (
  TIMDEXEmbeddings,  
  TIMDEXRecords,
  # soon, TIMDEXFulltexts....
)

With a new data type "fulltexts" coming online soon, and the refactoring of "records" and "embeddings" into equal footing data types, it felt like a good time to establish a dedicated space for data type definitions.

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

make test + make lint should be sufficient; just modification of imports.

Includes new or updated dependencies?

NO

Changes expectations for external applications?

NO

What are the relevant tickets?

Code review

  • Code review best practices are documented here and you are encouraged to have a constructive dialogue with your reviewers about their preferences and expectations.

Why these changes are being introduced:

With a new data type "fulltexts" coming online soon, and the refactoring of
"records" and "embeddings" into equal footing data types, it felt like a good time
to establish a dedicated space for data type definitions.

How this addresses that need:

Adds new `data_types/` folder.  Records and Emmbeddings moved here, and Fulltexts
will live here soon.

Side effects of this change:
* None

Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/USE-531
@ghukill ghukill force-pushed the USE-531-fulltext-data-type branch from 879b8ae to 2909b44 Compare May 18, 2026 13:42
@ghukill ghukill marked this pull request as ready for review May 18, 2026 13:43
@ghukill ghukill requested a review from a team as a code owner May 18, 2026 13:43
@jonavellecuerdo jonavellecuerdo self-assigned this May 18, 2026
@ghukill ghukill merged commit dbcbb8b into main May 18, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants