Skip to content

Commit e6a4440

Browse files
committed
docs: Improve README and rename AGENTS.md to CONTRIBUTING.md
Restructures the README for clarity, providing separate instructions for users and developers. Renames AGENTS.md to the standard CONTRIBUTING.md to better signal its purpose for potential contributors.
1 parent d314b39 commit e6a4440

2 files changed

Lines changed: 37 additions & 4 deletions

File tree

File renamed without changes.

README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,29 @@ A privacy-aware linter for Python projects, designed to catch accidental leaks o
1313
- **CI/CD Friendly**: Exits with a non-zero code only on `ERROR` findings, allowing warnings to be reviewed without blocking development.
1414
- **Extensible**: Powered by a combination of custom AST checks and a Semgrep rule engine.
1515

16-
## Usage
16+
## Installation
17+
18+
It is highly recommended to install `privlog` within a project's virtual environment to avoid dependency conflicts.
1719

18-
First, install the tool in your project's virtual environment:
20+
**Recommended (Virtual Environment):**
1921
```sh
20-
pip install -e .
22+
# 1. Create and activate a virtual environment in your project directory
23+
python -m venv .venv
24+
source .venv/bin/activate # On Windows, use: .venv\Scripts\activate
25+
26+
# 2. Install privlog
27+
pip install privlog
2128
```
2229

23-
To run the checks, use the `privlog` command.
30+
**Global Installation:**
31+
*While not recommended for most workflows, you can also install it globally:*
32+
```sh
33+
pip install privlog
34+
```
35+
36+
## Usage
37+
38+
Once installed, run the `privlog` command on your project directory.
2439

2540
### Default (Errors Only)
2641

@@ -44,3 +59,21 @@ To see both `ERROR`s and `WARNING`s, use the `-w` or `--warnings` flag.
4459
privlog -w /path/to/your/project
4560
```
4661
This will display all findings, color-coded by severity, but will still only fail the build if `ERROR`s are present.
62+
63+
---
64+
65+
## For Developers
66+
67+
To set up a development environment to contribute to `privlog`:
68+
```sh
69+
# 1. Clone the repository and navigate into the directory
70+
git clone https://github.com/privlog-dev/privlog.git
71+
cd privlog
72+
73+
# 2. Create and activate a virtual environment
74+
python -m venv .venv
75+
source .venv/bin/activate
76+
77+
# 3. Install the tool in editable mode with development dependencies
78+
pip install -e .
79+
```

0 commit comments

Comments
 (0)