Development ¶

Contributing to UDOT Wrangler ¶

Setup ¶

Recommended Tools ¶

GitHub desktop to manage access to the main repository.
Git to conduct required version control.
VSCode to edit and test code.
Some type of terminal application (note, this comes with Mac/Ubuntu).

Setup Virtual Environment ¶

Create and/or activate the virtual environment where you want to install UDOT Wrangler.

Clone ¶

To effectively work on UDOT Wrangler locally, install it from a clone by either:

Use the GitHub user interface by clicking on the green button “clone or download” in the main UDOT wrangler repository page.
Use the command prompt in a terminal to navigate to the directory that you would like to store your udot wrangler clone and then using a git command to clone it.

Clone udot wrangler

cd path to where you want to put wrangler
git clone https://github.com/wsp-sag/udot_wrangler

Install in Develop Mode ¶

Install UDOT Wrangler in “develop” mode using the -e flag so that changes to your code will be reflected when you are using and testing udot wrangler:

Install UDOT Wrangler from Clone

cd udot_wrangler
pip install -e .

IDE Settings ¶

VSCode ¶

Select conda env as Python interpreter:

cmd-shift-P: Python: Select Interpreter

Development Workflow ¶

Create an issue for any features/bugs that you are working on.
Create a branch to work on a new issue (or checkout an existing one where the issue is being worked on).

Code of Conduct ¶

Contributors to the UDOT Wrangler Project are expected to read and follow the CODE_OF_CONDUCT for the project.

Contributors ¶

Sijia W.

Note

There are likely more contributors - feel free to add your name if we missed it!

Release History ¶

Changelog ¶

Notable changes and version history.

Version	Date	Comment
0.1.2	2025-07-20	Prototyped with Cache County network