Skip to content

Commit

Permalink
Add basic development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
bennettgoble committed Mar 16, 2023
1 parent 8f5faba commit 1f67ae0
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Official python serialization library for [Linden Lab Structured Data (LLSD)][llsd].

# Use
## Use

Install **llsd** with pip:
```
Expand Down Expand Up @@ -36,5 +36,27 @@ data = llsd.parse(data_binary)
# >>> {'foo: 'bar'}
```

## Develop

Requirements:

- [pre-commit](https://pre-commit.com/)

Set up a venv and install development dependencies:
```
python3 -m venv .venv
. .venv/bin/activate
pip install .[dev]
```

Run tests:
```
pytest
```

### Benchmarks

Benchmarks from commits to `main` are published [here](https://secondlife.github.io/python-llsd/dev/bench/).

[llsd]: https://wiki.secondlife.com/wiki/LLSD
[llbase]: https://pypi.org/project/llbase/

0 comments on commit 1f67ae0

Please sign in to comment.