Skip to content

Commit

Permalink
docs: install and develop
Browse files Browse the repository at this point in the history
  • Loading branch information
wusteven815 committed Dec 13, 2024
1 parent fe0f7e7 commit 75b80f6
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ A Python implementation of JSON Pointer ([RFC 6902](https://datatracker.ietf.org
- [About](#about)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Development](#development)
- [Linting and Formatting](#linting-and-formatting)
- [Building and Releasing](#building-and-releasing)
- [Examples](#examples)
- [`get_by_ptr`](#get_by_ptr)
- [`apply_patch`](#apply_patch)
Expand All @@ -26,9 +29,48 @@ A Python implementation of JSON Pointer ([RFC 6902](https://datatracker.ietf.org

Python 3.8 or higher is required. You can install the library with:
```sh
# TODO
# Linux/macOS
python3 -m pip install -U pyjsonpatch

# Windows
py -3 -m pip install -U pyjsonpatch
```

## Development

Install the dev requirements with:
```sh
# Linux/macOS
python3 -m pip install -r requirements-dev.txt

# Windows
py -3 -m pip install -r requirements-dev.txt
```

### Linting and Formatting

Run the [Ruff linter and formatter](https://docs.astral.sh/ruff/) with:
```sh
# Lint
ruff check --fix

# Format
ruff format
```

### Building and Releasing

Build with:
```sh
# Linux/macOS
python3 -m build

# Windows
py -3 -m build
```

Commit messages should follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and version numbers follow [Semantic Versioning](https://semver.org/). Releases require a version bump in [`pyproject.toml`](./pyproject.toml) alongside a push to main with that version as a tag.

## Examples

### `get_by_ptr`
Expand Down
1 change: 1 addition & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ruff==0.8.3

0 comments on commit 75b80f6

Please sign in to comment.