Skip to content

docs: add standard developer integration instructions #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
greyllmmoder merged 1 commit into from
Apr 5, 2026
Merged

docs: add standard developer integration instructions #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,31 @@ pip install "aztec-py[decode]" # Decode utility via python-zxing + Java
pip install "aztec-py[svg]" # lxml-backed SVG workflows (optional)
```

## Use In Your Project

Recommended dependency pins for production:

`requirements.txt`
```text
aztec-py>=0.11,<1.0
```

`pyproject.toml` (PEP 621)
```toml
[project]
dependencies = [
"aztec-py>=0.11,<1.0",
]
```

Install directly from GitHub when you need an unreleased fix:

```bash
pip install "aztec-py @ git+https://github.com/greyllmmoder/python-aztec.git@<tag-or-commit>"
```

For production, pin to a tag or commit SHA, not `main`.

## Quick Start

```python
Expand Down
Loading