@@ 4,17 4,14 @@
SQLAlchemy query builder for jQuery QueryBuilder
================================================
-[](https://builds.sr.ht/~ocurero/sqlalchemy-querybuilder/.build.yml?) [](https://codecov.io/gh/ocurero/sqlalchemy-querybuilder)
+[](https://www.repostatus.org/#active) [](https://builds.sr.ht/~ocurero/sqlalchemy-querybuilder/.build.yml?) [](https://codecov.io/gh/ocurero/sqlalchemy-querybuilder)
This package implements a sqlalchemy query builder for json data
generated with (but not limited to) [`jQuery QueryBuilder`](http://querybuilder.js.org/).
-
-Installation
-------------
-
- #!python
- pip install sqlalchemy-querybuilder
+* Open Source: Apache 2.0 license.
+* Website: <https://sr.ht/~ocurero/sqlalchemy-querybuilder/>
+* Documentation: <https://sqlalchemy-querybuilder.readthedocs.io/>
Quickstart
----------
@@ 26,7 23,7 @@ Using **sqlalchemy-querybuilder** is ver
from sqlalchemy_querybuilder import Filter
from myapp import models, query
- rule = {
+ rules = {
"condition": "OR",
"rules": [{
"field": "mytable.myfield",
@@ 34,34 31,8 @@ from myapp import models, query
"value": "foo"
},
],
- }
+ }
myfilter = Filter(models, query)
- print(myfilter)
+ print(myfilter.querybuilder(rules))
```
-
-The following attributes from the rules are ignored and therefore can be omitted:
-
-- `id`
-- `type`
-- `input`
-
-**WARNING**
-
-sqlalchemy-querybuilder does not do any kind of json validation.
-
-Filter class
-------------
-
-`Filter` accepts two arguments, `models` and `query`:
-
-- models - can either be a module defining classes which inherit from
- `declarative_base` or a dict of such classes with the name of the
- tables as keys.
-- query - a SQLAlchemy query object. Optionaly loaded with some
- entity.
-
-Release History
----------------
-
-`sqlalchemy-querybuilder` repo is hosted at [sourcehut](https://github.com/ocurero/sqlalchemy-querybuilder)