Package: curious
Curious traverses relationships in a relational database. Curious
queries allow users to explore relationships among objects, traverse
recursive relationships, and jump between loosely connected databases.
Curious also provides a JSON interface to the objects. Users and
programmers can use Curious queries in analysis scripts and
applications.Curious favors a data centric model of application construction; Curious
queries expose normalized, relational data, reducing UI dependency on UI
specific API end-points serving denormalized data. Changing what data an
UI needs no longer requires changing the UI specific end-points.Curious works well with deep data models with many relationships. A
Curious query can traverse 10s of foreign key like relationships
efficiently. Curious queries always operate on sets of objects, and can
connect a small number of objects via a relationship to a large number
of objects, then via another relationship from the large number of
objects to a smaller set again. For example, Book to Authors to Country
of Residence. Unlike GraphQL, Curious outputs relationships between
objects, rather than an ever growing tree of JSON representations of the
objects.ExampleBook.last(10) Book.author_set Author.country(continent__name="North America")Query LanguageThe query language allows traversing models by identfying the relationships between them,
through foreign keys in Django models, or arbitrary id-mapping functions. A Curious query
is a space-separated set of terms, which connect models together by relationships.Several kinds of “joins” are possible using these relationship primitives:A traditionalinner joinBook Book.author_setAleft outer join:Book.last(10)?(Book.author_set)Arecusrive join:Parent.children_*Furthermore, at each stage in a join,filteringcan happen:Filtering byDjango field lookups:BookBook.author_set(id__in=[2,3,4])Filtering bysubquery:Book+(Book.author_set(id__in=[2,3,4]))Filtering byexclusive subqueryBook-(Book.author_set(id__in=[2,3,4]))Finally, relationships can generatecounts:CountingBook Book.author_set__countConfiguring Curiousimport myapp.models
from curious import model_registry

def register():
  model_registry.register(myapp.models)Then includeregisterwhen your Django app boots up.Using CuriousTurn off CSRF. Deploy it as a Django app.Writing Customized RelationshipsUse filter and deferred to real functions.DevelopmentRequires Docker. Spin up your container using the provideddocker-compose.ymlfile and Makefile
by runningmake image. This creates an image with a correct git configuration for your user,
which makes it easy to release. All of the commands you should need to run are defined theMakefileas targets. All of the targets except forimage, are meant to be run inside the
Docker container, but can be run from the host machine by having-extappended to them. For
example, to run tests, you could either callmake testfrom inside the container, ormaketest-extfrom the host.If you are modifying the static assets during development, they can be recompiled with thebuild_assetsmake task, or by callingpython setup.py build_assets../make test-extDeploymentDeployment of tagged commits happens to PyPI automatically via Travis CI. To bump and deploy a new
version, runmakebump/[foo]-ext, where[foo]ismajor,minor, orpatch. Thengit push origin--tagsmaster.