Skip to content

Commit 0e71673

Browse files
authored
Merge pull request #3 from greyllmmoder/codex/feat-readme-developer-adoption-guide
docs: add standard developer integration instructions
2 parents 41202a2 + fbd2b5e commit 0e71673

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,31 @@ pip install "aztec-py[decode]" # Decode utility via python-zxing + Java
2929
pip install "aztec-py[svg]" # lxml-backed SVG workflows (optional)
3030
```
3131

32+
## Use In Your Project
33+
34+
Recommended dependency pins for production:
35+
36+
`requirements.txt`
37+
```text
38+
aztec-py>=0.11,<1.0
39+
```
40+
41+
`pyproject.toml` (PEP 621)
42+
```toml
43+
[project]
44+
dependencies = [
45+
"aztec-py>=0.11,<1.0",
46+
]
47+
```
48+
49+
Install directly from GitHub when you need an unreleased fix:
50+
51+
```bash
52+
pip install "aztec-py @ git+https://github.com/greyllmmoder/python-aztec.git@<tag-or-commit>"
53+
```
54+
55+
For production, pin to a tag or commit SHA, not `main`.
56+
3257
## Quick Start
3358

3459
```python

0 commit comments

Comments
 (0)