Utilities for centers accessing the NACC Data Platform to pull information about submissions.
Based on the flywheel-sdk package.
We encourage using these functions to avoid situations where data organization might be changed.
Formerly part of data-platform-demos, then the standalone nacc-common repo, now part of flywheel-gear-extensions.
flywheel-sdk>=20.0.0pydantic>=2.5.2,<3python-dateutil>=2.5.3,<3Distributions can be accessed via each release on GitHub.
You can use a release directly by referencing the release files in your package manager.
For instance, adding the following line to requirements.txt for use with pip:
nacc-common@ https://github.com/naccdata/nacc-common/releases/download/v3.0.0/nacc_common-3.0.0-py3-none-any.whl
The format of the URL stays consistent, so to use a newer version of the package replace the version number.
Most package managers use a similar format to add packages directly from GitHub.
nacc_common.data_identification — Data identification models (DataIdentification, ParticipantIdentification, VisitIdentification, FormIdentification, ImageIdentification)nacc_common.error_models — QC error and validation models (FileQCModel, FileError, GearTags)nacc_common.form_dates — Date parsing and conversion utilitiesnacc_common.pipeline — Pipeline project lookup utilitiesnacc_common.center_info — Center information lookupnacc_common.qc_report — QC report visitor classes for generating reportsnacc_common.error_data — Error and status data extraction from projectsnacc_common.field_names — Common field name constantsFor detailed documentation of the QC metadata structure, gear tagging conventions, and which gears use which mechanisms, see the QC Conventions reference page.