This is an automated email from the ASF dual-hosted git repository.
asorokoumov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/otava-website.git
The following commit(s) were added to refs/heads/master by this push:
new c44d1fc 0.7.0 fixups (#4)
c44d1fc is described below
commit c44d1fc742616dd110019e9e860241ac9c6962b0
Author: Alex Sorokoumov <[email protected]>
AuthorDate: Sun Nov 30 21:27:02 2025 -0800
0.7.0 fixups (#4)
* Update Contribution doc after switching to uv
* Fixup config paths
---
docs/basics.md | 2 +-
docs/contribute.md | 36 ++++++++++++++++++++++++------------
docs/csv.md | 2 +-
docs/grafana.md | 2 +-
docs/postgresql.md | 2 +-
5 files changed, 28 insertions(+), 16 deletions(-)
diff --git a/docs/basics.md b/docs/basics.md
index 5bd0585..2f685b8 100644
--- a/docs/basics.md
+++ b/docs/basics.md
@@ -25,7 +25,7 @@ otava list-metrics <test>
### Example
:::tip
-See
[otava.yaml](https://github.com/apache/otava/tree/master/examples/csv/otava.yaml)
for the full example configuration.
+See
[otava.yaml](https://github.com/apache/otava/tree/master/examples/csv/config/otava.yaml)
for the full example configuration.
:::
```
diff --git a/docs/contribute.md b/docs/contribute.md
index efca7d2..c1d71ec 100644
--- a/docs/contribute.md
+++ b/docs/contribute.md
@@ -1,33 +1,31 @@
# Setting up for development
-* Ensure that `python3` points to a version of python >= 3.8 (`python3
--version` will tell you). If it does not, use
[pyenv](https://github.com/pyenv/pyenv) to both install a recent python version
and make it your current python.
+* The project uses [uv](https://docs.astral.sh/uv/) for dependency management
and [tox](https://tox.wiki) for testing environments.
-* There are two wrappers (`poetryw` and `toxw`) that install and run the
correct versions of [poetry](https://python-poetry.org) and
[tox](https://tox.wiki) for you.
-
-* Run poetry to install dependencies:
+* Install dependencies using uv:
```
-./poetryw install
+uv sync --all-extras --dev
```
-* Run the development version of otava using poetry:
+* Run the development version of otava using uv:
```
-./poetryw run otava ...
+uv run otava ...
```
-See the [poetry docs](https://python-poetry.org/docs) for more.
+See the [uv docs](https://docs.astral.sh/uv/) for more.
# Running tests
```
-./poetryw run pytest
+uv run pytest
```
...or using [tox](https://tox.readthedocs.io/):
```
-./toxw
+uv run tox
```
# Linting and formatting
@@ -35,12 +33,26 @@ See the [poetry docs](https://python-poetry.org/docs) for
more.
Code-style is enforced using [ruff](https://docs.astral.sh/ruff/) and
[flake8](https://flake8.pycqa.org/); import optimisation is handled by
[isort](https://pycqa.github.io/isort/) and
[autoflake](https://pypi.org/project/autoflake/). Linting is automatically
applied when tox runs tests; if linting fails, you can fix trivial problems
with:
```
-./toxw -e format
+uv run tox -e format
```
+# Changing the LICENSE header
+
+To change the license header:
+1. Add the `--remove-header` arg to `.pre-commit-config.yaml`
+2. Run formatting (this will remove the license header entirely)
+```
+uv run tox -e format
+```
+3. Remove the `--remove-header` arg from `.pre-commit-config.yaml`
+4. Update `ci-tools/license-templates/LICENSE.txt`
+5. Run formatting
+```
+uv run tox -e format
+```
# Build a docker image
```
-./toxw -e docker-build
+uv run tox -e docker-build
```
diff --git a/docs/csv.md b/docs/csv.md
index 2e649dd..1e23d11 100644
--- a/docs/csv.md
+++ b/docs/csv.md
@@ -1,7 +1,7 @@
# Importing results from CSV
:::tip
-See
[otava.yaml](https://github.com/apache/otava/tree/master/examples/csv/otava.yaml)
for the full example configuration.
+See
[otava.yaml](https://github.com/apache/otava/tree/master/examples/csv/config/otava.yaml)
for the full example configuration.
:::
## Tests
diff --git a/docs/grafana.md b/docs/grafana.md
index b25ed4b..f48f167 100644
--- a/docs/grafana.md
+++ b/docs/grafana.md
@@ -30,7 +30,7 @@ of the path instead of the path
## Example
:::tip
-See
[otava.yaml](https://github.com/apache/otava/tree/master/examples/graphite/otava.yaml)
for the full Graphite & Grafana example.
+See
[otava.yaml](https://github.com/apache/otava/tree/master/examples/graphite/config/otava.yaml)
for the full Graphite & Grafana example.
:::
Start docker-compose with Graphite in one tab:
diff --git a/docs/postgresql.md b/docs/postgresql.md
index 77d6662..88d2138 100644
--- a/docs/postgresql.md
+++ b/docs/postgresql.md
@@ -1,7 +1,7 @@
# Importing results from PostgreSQL
:::tip
-See
[otava.yaml](https://github.com/apache/otava/tree/master/examples/postgresql/otava.yaml)
for the full example configuration.
+See
[otava.yaml](https://github.com/apache/otava/tree/master/examples/postgresql/config/otava.yaml)
for the full example configuration.
:::
## PostgreSQL Connection
