Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,25 @@ Ran 63 tests in 1.906s
OK


```
```

#### Use locally
- To calculate the confidence metric locally, use the example code available at [example.py](./src/example.py)

## Deployment

- The library can be pushed to [TestPy](https://test.pypi.org/project/osw-confidence-metric/) or [PYPI](https://pypi.org/project/osw-confidence-metric/)
### Deploy to TestPy
- On every push to `dev` branch, a workflow is triggered which publishes the updated version to TestPy

### Deploy to PyPI
- This happens whenever a tag/release is created with `*.*.*` notation (eg. 0.0.8)
- To change the version, change the version at [version.py](./src/osw_confidence_metric/version.py)
- To release a new version:
- Go to Github link of this repository
- Under [releases](https://github.com/TaskarCenterAtUW/TDEI-python-lib-confidence-metric/releases), click on `Draft a new release`
- Under `choose a new tag`, add a new tag `v*.*.*` , Generate Release notes
- Choose `main` branch for release
- Publish the release.
- This release triggers a workflow to generate the new version of the Package.
- The new package will be available at https://pypi.org/project/osw-confidence-metric/
Loading