From fe1ce08c93c209c7c01d55cdcc86d47a101e050d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabor=20K=C3=B6rber?= Date: Thu, 23 Jan 2025 16:44:54 +0100 Subject: [PATCH] docs: links to project, not pinning .python-version in library --- .gitignore | 1 + README.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) diff --git a/.gitignore b/.gitignore index 70a1105..580c28c 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,7 @@ wheels/ # Virtual environments .venv +.python-version # Specific to this repo uv.lock diff --git a/README.md b/README.md index a205e26..da60ad9 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,19 @@ Main target is support of dataclass and pydantic, and allow building readonly re A more in-depth explanation, why you would use this module is described [in the documentation](./docs/clean_architecture.md) +Project Home: + +- https://git.g4b.org/g4borg/django_records +- https://github.com/g4borg/django_records (copy) + +## How to install + +- First you have to add django_records to your projects' requirements (TODO: update this once packaged) +- For any model you want to be able to use records() on, you have to override the default Manager by creating it from the RecordQuerySet +- Mixins are available +- I suggest to study the code in records.py, as it is not much +- TODO: More in depth and less painful installation instructions. + ## The .records() queryset function > Changed since 0.3: records is not supposed take an optional first parameter as record target, instead use record_into(), however support for it is kept.