Elastic Git
Adventures in an declarative object-y thing backed by Git and using Elasticsearch as a query backend.
Usage
from elasticgit import EG
from elasticgit.models import Model, IntegerField, TextField
workspace = EG.workspace('/Users/sdehaan/Desktop/test-repo/')
workspace.setup('Simon de Haan', 'simon@praekeltfoundation.org')
"""
# The model looks like this
class Person(Model):
age = IntegerField('The Age')
name = TextField('The Name')
"""
from elasticgit.tests.base import TestPerson as Person
person1 = Person({'age': 10, 'name': 'Foo'})
workspace.save(person1, 'Saving Person 1')
person2 = Person({'age': 20, 'name': 'Bar'})
workspace.save(person2, 'Saving Person 2')
person3 = Person({'age': 30, 'name': 'Baz'})
workspace.save(person3, 'Saving Person 3')
Data is now persisted in a git repository and is queryable via elasticsearch:
>>> from elasticgit import EG
>>> from elasticgit.tests.base import TestPerson as Person
>>> workspace = EG.workspace('/Users/sdehaan/Desktop/test-repo/')
>>> for person in workspace.S(Person).filter(age__gte=20):
... print person.name, person.age
...
Bar 20
Baz 30
Check the examples/ directory for some more code samples.
$ python -m examples.basic_usage
e6cb25f00870472fa5223d76dc361667 Baz 30
2bd470372243411c9abd8fdcb969dcf5 Bar 20
Schema Management
We’ve followed the example of Apache Avro when it comes to schema evolution. Avro compatible schemas can be generated from the command line.
Model definitions can be rebuilt from Avro JSON schema files.
A sample model file:
class TestFallbackPerson(Model):
age = IntegerField('The Age')
name = TextField('The name', fallbacks=[
SingleFieldFallback('nick'),
SingleFieldFallback('obsolete'),
])
nick = TextField('The nickname', required=False)
obsolete = TextField('Some obsolete field', required=False)
Generating the Avro spec file
$ python -m elasticgit.tools dump-schema \
> elasticgit.tests.base.TestFallbackPerson > avro.json
$ python -m elasticgit.tools load-schema avro.json > models.py
The generated model file:
# NOTE:
#
# This is an automatically generated Elasticgit Model definition
# from an Avro schema. Do not manually edit this file unless you
# absolutely know what you are doing.
#
# timestamp: 2014-10-14T18:51:23.916194
# namespace: elasticgit.tests.base
# type: record
# name: TestFallbackPerson
#
from elasticgit import models
class TestFallbackPerson(models.Model):
name = models.TextField(u"""The name""", fallbacks=[models.SingleFieldFallback('nick'),models.SingleFieldFallback('obsolete'),])
age = models.IntegerField(u"""The Age""")
obsolete = models.TextField(u"""Some obsolete field""")
_version = models.ModelVersionField(u"""Model Version Identifier""")
nick = models.TextField(u"""The nickname""")
uuid = models.TextField(u"""Unique Identifier""")
We’re using ConfModel’s fallbacks feature and encode this in Avro’s Schema as aliases. This allows you to fall back to older names for fields:
>>> TestFallbackPerson({'obsolete': 'oldest name', 'age': 10}).name
'oldest name'
>>> TestFallbackPerson({'nick': 'older name', 'age': 10}).name
'older name'
>>> TestFallbackPerson({'name': 'current name', 'age': 10}).name
'current name'
Metadata
Release files for elastic-git 1.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| elastic-git-1.5.0.tar.gz | 39.9 kB | Without provenance | Details for elastic-git-1.5.0.tar.gz |
Release files / elastic-git-1.5.0.tar.gz
| Download URL | elastic-git-1.5.0.tar.gz |
|---|---|
| Size | 39.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1d2dbf18ac88d5abd3ad0a46a576a9462c1aa7aa9e98caa278b100ced481c9b2
|
|
BLAKE2b-256 checksum How to use checksums |
2d77c0fbc01fc80f8a3de60c1cfa73fe935b47c3ccc9d9d1c3c3467b3e0ecb9b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for elastic-git 1.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.