This is a package of utilities that can be used by the centers accessing the NACC Data Platform to pull information about submissions.
The package is based on the flywheel-sdk package.
We encourage using these functions to avoid situations where data organization might be changed.
This repository is setup to use pants for developing and building the distributions.
Install pants with the command
bash get-pants.sh
You will need to make sure that you have a Python version compatible with the interpreter set in the pants.toml file.
The repo has a VSCode devcontainer configuration that ensures a compatible Python is available. You need Docker installed, and VSCode with Dev Containers enabled. For this follow the Dev Containers tutorial to the point of “Check Installation”.
Once pants is installed, the command
pants package nacc-common::
will then build sdist and wheel distributions in the dist directory.
The version number on the distribution files is set in the
nacc-common/BUILDfile.
Format the code with the command
pants fix ::
and commit any changes.
Ensure the repository passes the checks
pants lint ::
pants check ::
and fix any issues and commit the changes.
Update the version number in nacc_common/BUILD.
(This isn’t strictly necessary, because the build script uses the tag version.)
Create and push the release tag
export VERSION=v<current-version>
git tag -a "$VERSION" -m "NACC Common Package $VERSION"
git push --tags
The <current-version> should use semantic versioning.
For instance, it should have the form 1.1.2, meaning the tag will look like v1.1.2.
The build GitHub action will create a new release with the tag as the version number.