Skip to content

Commit f1bd4e0

Browse files
committed
docs: add README.md
1 parent 4a8e0b1 commit f1bd4e0

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Athena Client Library
2+
3+
This is a Python library for interacting with the Athena API (Resolver Unknown
4+
CSAM Detection).
5+
6+
7+
## Development
8+
This package uses [uv](https://docs.astral.sh/uv/) to manage its packages.
9+
10+
To install dependencies, run:
11+
12+
```bash
13+
uv sync --dev
14+
```
15+
16+
To build the package, run:
17+
18+
```bash
19+
uv build
20+
```
21+
22+
To run the tests, run:
23+
24+
```bash
25+
pytest
26+
```
27+
28+
To lint and format the code, run:
29+
30+
```bash
31+
ruff check
32+
ruff format
33+
```
34+
35+
There are pre-commit hooks that will run these commands automatically before
36+
committing changes. Install them with:
37+
38+
```bash
39+
pre-commit install
40+
```
41+
42+
To re-compile the protobuf files, run from the repository's root directory:
43+
44+
```bash
45+
bash scripts/compile_protobuf.sh
46+
```

0 commit comments

Comments
 (0)