Skip to content

Commit ab0e374

Browse files
authored
chore: minor adjustment (#722)
* chore(md): edit md * chore(justfile): remove unused command * chore(toml): edit dependencies
1 parent 04add7d commit ab0e374

File tree

5 files changed

+15
-40
lines changed

5 files changed

+15
-40
lines changed

ibis-server/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ docker compose up
4848
### Running on Local
4949
Requirements:
5050
- Python 3.11
51+
- [casey/just](https://github.com/casey/just)
5152
- [poetry](https://github.com/python-poetry/poetry)
5253
- [Rust](https://www.rust-lang.org/tools/install) and [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
5354

ibis-server/docs/development.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,26 @@ To start the server:
3434
- Execute `just dev` to start the server in development mode (auto-reloads on code changes)
3535
- The default port is `8000`. You can change it by running `just port=8001 run` or `just port=8001 dev`
3636

37-
### Environment Variables
38-
- `WREN_ENGINE_ENDPOINT`: The endpoint of the Wren Java engine
39-
4037
### Docker
4138
- Build the image: `just docker-build`
4239
- Run the container: `just docker-run`
4340

4441
### Run the testing
45-
- Preapre the Wren Engine server (see [Wren Engine Example](../example/README.md)
46-
- Run pytest with `WREN_ENGINE_ENDPOINT` env. (The default port of Wren Engine is 8080)
47-
- run specific data source test using [pytest marker](https://docs.pytest.org/en/stable/example/markers.html). There are some markers for different data sources. See the list in [pyproject.toml](../pyproject.toml).
42+
- Prepare the Wren Engine server (see [Wren Engine Example](../../example/README.md))
43+
- Use the `.env` file to set the `WREN_ENGINE_ENDPOINT` environment variable to change the endpoint of the Wren Engine server.
44+
```
45+
WREN_ENGINE_ENDPOINT=http://localhost:8080
46+
```
47+
More information about the environment variables can be found in the [Environment Variables](#Environment-Variables) section.
48+
- Run specific data source test using [pytest marker](https://docs.pytest.org/en/stable/example/markers.html). There are some markers for different data sources. See the list in [pyproject.toml](../pyproject.toml).
4849
```
49-
WREN_ENGINE_ENDPOINT=http://localhost:8080 just test 'postgres'
50+
just test postgres
5051
```
5152

53+
### Environment Variables
54+
- `WREN_ENGINE_ENDPOINT`: The endpoint of the Wren Java engine
55+
56+
5257
## How to add new data source
5358
Please see [How to Add a New Data Source](how-to-add-data-source.md) for more information.
5459

ibis-server/justfile

-3
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ install *args:
2020
pre-commit-install:
2121
poetry run pre-commit install
2222

23-
maturin:
24-
poetry run maturin develop
25-
2623
port := "8000"
2724

2825
run:

ibis-server/poetry.lock

+1-27
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

ibis-server/pyproject.toml

+1-3
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ httpx = "0.27.0"
2525
python-dotenv = "1.0.1"
2626
orjson = "3.10.6"
2727
pandas = "2.2.2"
28-
pymysql = "^1.1.1"
29-
clickhouse-connect = "0.7.16"
3028
sqlglot = ">=23.4,<25.7"
3129
loguru = "0.7.2"
3230

@@ -42,9 +40,9 @@ testcontainers = { version = "4.7.2", extras = [
4240
sqlalchemy = "2.0.31"
4341
pre-commit = "3.7.1"
4442
ruff = "0.5.4"
45-
maturin = "1.7.0"
4643
trino = ">=0.321,<1"
4744
psycopg2 = ">=2.8.4,<3"
45+
clickhouse-connect = "0.7.16"
4846

4947
[tool.pytest.ini_options]
5048
addopts = ["--strict-markers"]

0 commit comments

Comments
 (0)