Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![PyPI - License](https://img.shields.io/pypi/l/pysimdjson.svg?style=flat-square)
![Tests](https://github.com/TkTech/pysimdjson/workflows/Run%20tests/badge.svg)
[![tests](https://github.com/TkTech/pysimdjson/actions/workflows/release.yml/badge.svg)](https://github.com/TkTech/pysimdjson/actions/workflows/release.yml)

# pysimdjson

Expand All @@ -10,7 +10,8 @@ pysimdjson safe to use anywhere.
Bindings are currently tested on OS X, Linux, and Windows for Python version
3.9 to 3.12.

## 📝 Documentation

## 📈 Documentation

The latest documentation can be found at https://pysimdjson.tkte.ch.

Expand All @@ -24,3 +25,33 @@ found in its sister project [json_benchmark][].

[simdjson]: https://github.com/lemire/simdjson
[json_benchmark]: https://github.com/tktech/json_benchmark

## 📈 Building Locally

To build pysimdjson from source, you'll need Python 3.9+ and a C++ compiler.

1. **Install uv** (if not already installed):
```bash
pip install uv
```

2. **Clone the repository**:
```bash
git clone https://github.com/TkTech/pysimdjson.git
cd pysimdjson
```

3. **Build the package**:
```bash
uv sync
```

4. **(Optional) Run tests**:
```bash
uv run pytest
```

5. **(Optional) Build documentation**:
```bash
cd docs && uv run make html
```
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ build-backend = "setuptools.build_meta"
[project]
name = "pysimdjson"
version = "7.0.2"
description = "Add your description here"
description = "Python bindings for the simdjson project, a SIMD-accelerated JSON parser"
readme = "README.md"
license = "MIT"
requires-python = ">=3.9"
dependencies = [
]
Expand Down
Loading
Loading