Skip to main content
Version: Upcoming 🚧

Working with pysodafair

About pysodafair​

pysodafair is a Python library that provides backend functionality for SODA. It handles critical dataset management operations, such as generating manifest files and uploading datasets to Pennsieve. When making modifications to this process, you will generally need to make changes to pysodafair.

Making Changes to pysodafair​

To develop and test changes to pysodafair:

  1. Clone the pysodafair repository:
git clone https://github.com/fairdataihub/pysodafair
  1. Create a new branch off of staging:
git checkout staging
git checkout -b your-branch-name

  1. Make your changes to the code in your branch

  2. Activate the conda environment:

conda activate env-electron-python
  1. Install pysodafair in editable mode to test your changes locally:
pip install -e .
  1. Launch SODA to test your pysodafair changes:
npm run dev

The application will now use your modified version of pysodafair, allowing you to test the changes that were made with SODA running locally.