Skip to content

Commit 52626b3

Browse files
committed
Update README.md
1 parent 0785d04 commit 52626b3

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ OSW-Incline is a Python library for calculating the incline of geographical feat
99
- [Examples](#examples)
1010
- [Running Tests](#running-tests)
1111
- [How To Get DEM Files From NED Database](#how-to-get-dem-files-from-ned-database)
12+
- [Deployment of the Library](#deployment)
1213
- [License](#license)
1314

1415
## Features
@@ -202,5 +203,25 @@ class DEMDownloader:
202203
```
203204
**NOTE:** `ned_13_index.json` file contains the index of all the DEM files available in the NED database. You can download the DEM files by providing the tile name can be found [here](https://github.com/TaskarCenterAtUW/TDEI-python-lib-osw-inclination/blob/main/ned_13_index.json)
204205
206+
207+
## Deployment
208+
209+
- The library can be pushed to [TestPy](https://test.pypi.org/project/osw-incline/) or [PYPI](https://pypi.org/project/osw-incline/)
210+
### Deploy to TestPy
211+
- On every push to `dev` branch, a workflow is triggered which publishes the updated version to TestPy
212+
213+
### Deploy to PyPI
214+
- This happens whenever a tag/release is created with `*.*.*` notation (eg. 0.0.8)
215+
- To change the version, change the version at [version.py](./src/osw_confidence_metric/version.py)
216+
- To release a new version:
217+
- Go to Github link of this repository
218+
- Under [releases](https://github.com/TaskarCenterAtUW/TDEI-python-lib-osw-inclination/releases), click on `Draft a new release`
219+
- Under `choose a new tag`, add a new tag `v*.*.*` , Generate Release notes
220+
- Choose `main` branch for release
221+
- Publish the release.
222+
- This release triggers a workflow to generate the new version of the Package.
223+
- The new package will be available at https://pypi.org/project/osw-incline/
224+
225+
205226
## License
206227
This project is licensed under the MIT License. See the [LICENSE](https://github.com/TaskarCenterAtUW/TDEI-python-lib-osw-inclination/blob/main/LICENSE) file for details

0 commit comments

Comments
 (0)