Set Up Versioneer for Version Control of ACCESS-Vis Package

[rbeucher]

Set Up Versioneer for Version Control of ACCESS-Vis Package

Description:

We need to integrate Versioneer into the ACCESS-Vis package for version control. Versioneer simplifies the process of managing versioning in Python projects by automatically extracting the version number from the version control system (e.g., Git) and incorporating it into the package.

Action Required:

1. Install Versioneer

   • Add Versioneer to the project by running the installation command:

     pip install versioneer

2. Configure Versioneer

   • Follow the Versioneer documentation to configure it for the ACCESS-Vis package. This includes:
     • Adding the necessary versioneer.py file to the package directory.
     • Updating the pyproject.toml file to include Versioneer settings, specifically the version source.

3. Update Package Metadata

   • Modify the pyproject.toml file to use Versioneer for version management. This will involve specifying the versioning mechanism in the configuration.

4. Remove Manual Versioning

   • Remove any existing manual versioning mechanisms from the package to avoid conflicts with Versioneer.

5. Documentation

   • Update the README.md or CONTRIBUTING.md files with information on how versioning will be handled going forward, including any relevant commands for creating new versions.

6. Testing

   • Verify that the versioning works correctly by creating a new Git tag and ensuring the version number is reflected in the package.

Expected Outcome:

The ACCESS-Vis package will utilize Versioneer for version control, allowing for automated version management based on the Git tags, which will streamline the release process and ensure consistent versioning across the package.

Additional Resources:

• Versioneer documentation can be found here: Versioneer Documentation.

[rbeucher]

Done