Home

Welcome to the actio_python_utils wiki!

Testing Instructions

1. Navigate to the Directory:

cd actio_python_utils

2. Create a New Conda Environment:

conda create -n actio_python_utils python=3.11 openjdk=8

3. Activate the Conda Environment:

conda activate actio_python_utils

4. Install Required Packages:

pip install -r requirements.txt

5. Run the Tests:

python -m unittest tests.test_db_connection

Installing to Another Project

1. Navigate to Your Project's Directory:

cd your_project_directory

2. Install actio_python_utils via Git:

pip install git+https://github.com/ActioBio/actio_python_utils.git

Updating and Deploying to GitHub Pages

1. Navigate to the Directory:

cd actio_python_utils

2. Build the Sphinx Documentation

# change to the sphinx directory
cd sphinx

# run the Sphinx build command to generate the HTML output
make html

# after the build completes, navigate back to the project root directory
cd ..

3. Copy the Generated HTML to the docs Directory

cp -r sphinx/_build/html/* docs/

4. Commit and Push Changes to GitHub

git add sphinx/ docs/
git commit -m "Update documentation and deploy to GitHub Pages"
git push origin main