Skip to content

Commit

Permalink
docs(bindings/python): Add building docs
Browse files Browse the repository at this point in the history
Signed-off-by: Xuanwo <github@xuanwo.io>
  • Loading branch information
Xuanwo committed Mar 9, 2023
1 parent f5c78ad commit 201b87d
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions bindings/python/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,36 @@
# OpenDAL Python Binding

This crate intends to build a native python binding.

## Building

Install `maturin`:

```shell
pip install maturin
```

Setup virtualenv:

```shell
virtualenv venv
```

Activate venv:

```shell
source venv/bin/activate
````

Build bindings:

```shell
maturin develop
```

Running some tests:

```shell
pip install -r test_requirements.txt
pytest
```

1 comment on commit 201b87d

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for opendal ready!

✅ Preview
https://opendal-5wfc21w8e-databend.vercel.app
https://opendal-git-docs-for-python-bindings.vercel.app

Built with commit 201b87d.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.