Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jsstevenson committed Jan 16, 2024
1 parent 115b455 commit 7a7a7f7
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ from chainlifter.lifter import ChainLifter
ch = ChainLifter("hg38", "hg19")
```

Call ``convert_coordinate``:
Call ``convert_coordinate()``:

```python3
ch.convert_coordinate("chr7", 140453136, "+")
Expand All @@ -27,11 +27,23 @@ Create a virtual environment and install developer dependencies:
```shell
python3 -m virtualenv venv
source venv/bin/activate
python3 -m pip install -e '.[dev]'
python3 -m pip install -e '.[dev,tests]'
```

Be sure to install pre-commit hooks:

```shell
pre-commit install
```

This installs Python code as editable, but after any changes to Rust code, ``maturin develop`` must be run:

```shell
maturin develop
```

Run tests with `pytest`:

```shell
pytest
```

0 comments on commit 7a7a7f7

Please sign in to comment.