Skip to content

Commit

Permalink
Merge pull request #11 from secondlife/signal/bench-readme
Browse files Browse the repository at this point in the history
Add basic development instructions
  • Loading branch information
nat-goodspeed authored Mar 16, 2023
2 parents 438e41d + 1f67ae0 commit c4035fb
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/

1 comment on commit c4035fb

@github-actions
Copy link

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Python Benchmarks'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.10.

Benchmark suite Current: c4035fb Previous: 438e41d Ratio
tests/bench.py::test_parse_xml_stream 8300.473669688761 iter/sec (stddev: 0.00005706394950755007) 12495.159989307285 iter/sec (stddev: 0.000001796551337468087) 1.51
tests/bench.py::test_parse_notation_stream 2170.2928269190556 iter/sec (stddev: 0.00029043219624840633) 3009.6538886291164 iter/sec (stddev: 0.00021585645151115033) 1.39
tests/bench.py::test_parse_binary_stream 9755.97508852484 iter/sec (stddev: 0.00006527358784005084) 13524.361867793872 iter/sec (stddev: 0.000031128561715433327) 1.39
tests/bench.py::test_parse_notation_bytes 2657.2559583178227 iter/sec (stddev: 0.0001100800966197872) 3703.0402892099933 iter/sec (stddev: 0.00003487006193489698) 1.39
tests/bench.py::test_parse_xml_bytes 9057.213634529715 iter/sec (stddev: 0.000060535948325585013) 13713.750342074072 iter/sec (stddev: 0.0000020156423101261827) 1.51
tests/bench.py::test_parse_binary_bytes 10356.718680816699 iter/sec (stddev: 0.00006844433281053462) 14466.237302542444 iter/sec (stddev: 0.00003324372179853647) 1.40
tests/bench.py::test_format_xml 10817.987785820233 iter/sec (stddev: 0.00005813904804121425) 15020.580807426615 iter/sec (stddev: 0.0000012655967514258396) 1.39
tests/bench.py::test_format_notation 18440.266312430256 iter/sec (stddev: 0.000051923028874614916) 25999.305531143098 iter/sec (stddev: 0.000013443974619298474) 1.41
tests/bench.py::test_format_binary 18598.440988295966 iter/sec (stddev: 0.00003668074092684782) 26090.624414662354 iter/sec (stddev: 0.0000010597874351514089) 1.40

This comment was automatically generated by workflow using github-action-benchmark.

Please sign in to comment.