...
This commit is contained in:
20
README.md
20
README.md
@@ -17,6 +17,12 @@ To install in editable mode for development:
|
||||
uv pip install -e git+https://git.ourworld.tf/herocode/herolib_python.git#egg=herolib
|
||||
```
|
||||
|
||||
To install from a local path (if you have cloned the repository locally):
|
||||
|
||||
```bash
|
||||
uv pip install -e "$HOME/code/git.ourworld.tf/herocode/herolib_python"
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Once installed, you can import modules from the `herolib` package:
|
||||
@@ -31,20 +37,6 @@ from herolib.core.loghandler.mylogging import MyLogger
|
||||
|
||||
see [Python Herolib Integration](pythonsetup/README.md)
|
||||
|
||||
## Version Control
|
||||
|
||||
This library follows standard Git version control practices. Releases can be managed by tagging specific commits in the Git repository. Users installing directly from the Git URL can specify a particular branch, tag, or commit hash to get a specific version. For example:
|
||||
|
||||
```bash
|
||||
# Install from a specific branch
|
||||
uv pip install git+https://git.ourworld.tf/herocode/herolib_python.git@main
|
||||
|
||||
# Install from a specific tag (e.g., v0.1.0)
|
||||
uv pip install git+https://git.ourworld.tf/herocode/herolib_python.git@v0.1.0
|
||||
|
||||
# Install from a specific commit hash
|
||||
uv pip install git+https://git.ourworld.tf/herocode/herolib_python.git@<commit_hash>
|
||||
```
|
||||
|
||||
## Adding as a Dependency in `pyproject.toml`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user