From c535559ee4f27efc14089dcaf032c392168a773a Mon Sep 17 00:00:00 2001 From: Ming Date: Mon, 24 Mar 2025 15:52:48 +1100 Subject: [PATCH] PIE-3504 part 1: lock python version, add venv setup instruction --- .github/workflows/python.yaml | 2 +- .gitignore | 2 ++ .tool-versions | 1 + README.md | 10 ++++++++-- 4 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 .tool-versions diff --git a/.github/workflows/python.yaml b/.github/workflows/python.yaml index 7c1fadd..2d914e3 100644 --- a/.github/workflows/python.yaml +++ b/.github/workflows/python.yaml @@ -33,7 +33,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ] + python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12', '3.13' ] steps: - uses: actions/checkout@v4 diff --git a/.gitignore b/.gitignore index 82d23bc..1ef15ac 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,5 @@ __pycache__ .tox .env* + +.direnv/* diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 0000000..3c35347 --- /dev/null +++ b/.tool-versions @@ -0,0 +1 @@ +python 3.13.2 diff --git a/README.md b/README.md index 02fe6ac..28ab842 100644 --- a/README.md +++ b/README.md @@ -58,15 +58,21 @@ See the [GitHub 'enhancement' issues](https://github.com/buildkite/test-collecto ## ⚒ Developing -After cloning the repository, install the dependencies: +After cloning the repository, setup virtual environment (please skip this step if you are using `direnv`): +```bash +python -m venv .venv && source .venv/bin/activate ``` + +then install the dependencies: + +```bash pip install -e '.[dev]' ``` And run the tests: -``` +```bash pytest ```