/auto-gov

Primary LanguagePython

auto.gov

python

Preperation

Install Rust for sumtree if you do not have this in your local machine.

  • MacOS / Linux
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  • Windows

Visit https://doc.rust-lang.org/cargo/getting-started/installation.html and follow downloading instructions.

Setup

git clone https://github.com/xujiahuayz/auto-gov.git
cd auto-gov

Give execute permission to your script and then run setup_repo.sh

chmod +x setup_repo.sh
./setup_repo.sh
. venv/bin/activate

or follow the step-by-step instructions below between the two horizontal rules:

Create a python virtual environment

  • MacOS / Linux
python3 -m venv venv
  • Windows
python -m venv venv

Activate the virtual environment

  • MacOS / Linux
. venv/bin/activate
  • Windows (in Command Prompt, NOT Powershell)
venv\Scripts\activate.bat

Install toml

pip install toml

Install the project in editable mode

pip install -e ".[dev]"

Git Large File Storage (Git LFS)

All files in data/ are stored with lfs:

git lfs track data/**/*