Metadata-Version: 2.4
Name: riverjoin
Version: 0.1.0
Summary: This is a river join implementation in Python.
Author-email: Supath Dhital <sdhital@crimson.ua.edu>, Yixian Chen <ychen223@ua.edu>
Project-URL: Homepage, https://github.com/sdmlua/riverjoin_py
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: geopandas
Requires-Dist: pathlib
Requires-Dist: fiona
Requires-Dist: folium
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"

# Framework for Spatially Joining two Hydrofabric Flowlines
<hr style="border: 1px solid black; margin: 0;"> 

## Update the code
```bash
git clone https://github.com/sdmlua/riverjoin_py
cd riverjoin_py
```

Use the ```uv``` to work and update the code,
```bash
pip install uv

#Create a virtual env and start collabortaing the code
uv venv

#activate the virtual environment
source .venv/bin/activate

#Install all the dependencies and all development packages into it
uv pip install e .
uv pip install -e ".[dev]"

#Then add/edit modules under the src/ and run the code through the tests
#For instance
pytest tests/spatial_join.py
```
Once all changes are made, update the code style with ```black``` code formatter.
```bash
black .
```
