Skip to content

Commit

Permalink
chore: remove the dev setup script
Browse files Browse the repository at this point in the history
  • Loading branch information
ludwiktrammer committed Jan 23, 2025
1 parent 839271e commit a03e254
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 49 deletions.
29 changes: 9 additions & 20 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,15 @@ jobs:
path: ~/.cache/pre-commit
key: pre-commit-3|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}

- name: Install Dependencies
run: source ./setup_dev_env.sh

- name: Run pre-commit checks
run: |
source .venv/bin/activate
pre-commit run --all-files --show-diff-on-failure --color always
uv run pre-commit run --all-files --show-diff-on-failure --color always
- name: Run ruff formatter
run: uvx ruff format --check
run: uv run ruff format --check

- name: Run ruff linter
run: uvx ruff check
run: uv run ruff check

- name: Run mypy
run: uv run mypy .
Expand Down Expand Up @@ -79,18 +75,15 @@ jobs:

- name: Check licenses
run: |
source .venv/bin/activate
./check_licenses.sh
uv run ./check_licenses.sh
- name: Check documentation builds correctly
run: |
source .venv/bin/activate
mkdocs build --strict
uv run mkdocs build --strict
- name: Generate pip freeze
run: |
source .venv/bin/activate
pip freeze > requirements-freeze.txt
uv pip freeze > requirements-freeze.txt
- name: Publish Artefacts
uses: actions/upload-artifact@v3
Expand Down Expand Up @@ -167,16 +160,12 @@ jobs:
path: ~/nltk_data
key: nltk-${{ runner.os }}

- name: Install Dependencies
run: source ./setup_dev_env.sh

- name: Run Tests With Coverage
run: |
# run with coverage to not execute tests twice
source .venv/bin/activate
coverage run -m pytest -v -p no:warnings --junitxml=report.xml
coverage report
coverage xml
uv run coverage run -m pytest -v -p no:warnings --junitxml=report.xml
uv run coverage report
uv run coverage xml
- name: Test Report
uses: mikepenz/action-junit-report@v4
Expand Down
6 changes: 1 addition & 5 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,9 @@ jobs:
restore-keys: |
${{ runner.os }}-pip-
- name: Install Dependencies
shell: bash
run: source ./setup_dev_env.sh

- name: Deploy docs
shell: bash
run: ./.github/scripts/deploy_docs.sh
run: uv run ./.github/scripts/deploy_docs.sh
env:
GCP_KEY: ${{ secrets.GCP_KEY }}

13 changes: 5 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,22 @@

## Build from source

To build and run Ragbits from the source code:
Dependencies needed to build and run Ragbits from the source code:

1. Requirements: [**uv**](https://docs.astral.sh/uv/getting-started/installation/) & [**python**](https://docs.astral.sh/uv/guides/install-python/) 3.10 or higher
2. Install dependencies and run venv in editable mode:
1. [**uv**](https://docs.astral.sh/uv/getting-started/installation/)
2. [**python**](https://docs.astral.sh/uv/guides/install-python/) 3.10

```bash
$ source ./setup_dev_env.sh
```

## Linting and formatting
We use `ruff` for linting and formatting our code. To format your code, run:

```bash
$ uvx ruff format
$ uv run ruff format
```

To lint the code, run:
```bash
$ uvx ruff check --fix
$ uv run ruff check --fix
```

## Type checking
Expand Down
2 changes: 0 additions & 2 deletions check_licenses.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
#!/bin/bash
set -e

source .venv/bin/activate

uv run pip-licenses --from=mixed --ignore-packages `cat .libraries-whitelist.txt`> licenses.txt
cat licenses.txt

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -290,9 +290,9 @@ async def test_document_search_ingest_from_uri_with_wildcard(
results = await document_search.search(search_query)

# Check that we have the expected number of results
assert len(results) == len(expected_contents), (
f"Expected {len(expected_contents)} result(s) but got {len(results)}"
)
assert len(results) == len(
expected_contents
), f"Expected {len(expected_contents)} result(s) but got {len(results)}"

# Verify each result is a TextElement
assert all(isinstance(result, TextElement) for result in results)
Expand Down
11 changes: 0 additions & 11 deletions setup_dev_env.sh

This file was deleted.

0 comments on commit a03e254

Please sign in to comment.