docs: real repo url + pip install command

point install at git.rethinkstudios.io; show both the requirements.txt
line and the direct pip install command.

Signed-off-by: disqualifier <dev@disqualifier.me>
This commit is contained in:
disqualifier 2026-06-23 13:09:09 -04:00
parent 3922295f2c
commit 92ea363cb7
2 changed files with 13 additions and 7 deletions

View File

@ -5,9 +5,16 @@ helpers for the common paths, with a raw escape hatch for everything else.
## Install
`requirements.txt`:
```
mongo @ git+https://git.rethinkstudios.io/rethink-public/mongo@v0.1.0
```
Direct:
```bash
# requirements.txt
mongo @ git+ssh://git@github.com/<org>/mongo.git@v0.1.0
pip install "mongo @ git+https://git.rethinkstudios.io/rethink-public/mongo@v0.1.0"
```
Requires `motor` and `pymongo` (pulled transitively).

View File

@ -1,17 +1,16 @@
[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
requires = ["hatchling"]
build-backend = "hatchling.build"
[project]
name = "mongo"
version = "0.1.0"
description = "async mongodb wrapper over motor with a raw escape hatch"
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
"motor>=3.0",
"pymongo>=4.0",
]
[tool.setuptools.packages.find]
where = ["src"]
[tool.hatch.build.targets.wheel]
packages = ["src/mongo"]