Merge pull request #109 from cavokz/release-v0.1.0

Prepare v0.1.0

CHANGES.md

@@ -0,0 +1,17 @@
+## v0.1.0 - Nov 15, 2022
+
+First documented release. What you can do with it:
+
+* generate a lot of data, either in form of plain json content or documens already ingested in our favourite stack, Elasticsearch
+* define a data model which describes the documents, the relations among them and their fields
+* define a schema which specifies the type of each field (you cannot generate content without describing the meaning of it)
+
+Of the above, the most definitve is the schema. Geneve uses [ECS](https://www.elastic.co/guide/en/ecs/current/index.html) as reference, you can use any alternative but it shall be defined in the same format as ECS.
+
+About data models, they are a vast topic and any implementation is necessarily open and incomplete. Just to give a feeling of what you can already generate, think at the Elastic Security Solution [detection rules](https://www.elastic.co/guide/en/security/current/detection-engine-overview.html). There are about 650 of them and you can generate documents to reliably trigger ~550 security alerts.
+
+Is all this enough for filling up your stack with useful data? Not even close. Sure you can exhaust the storage but that alone is not very useful.
+
+Indeed it's all interesting only if you can use Kibana to analyze it, exercise all the features and goodies it ships on every release, feel how it would be once you get in production.
+
+At the moment there is enough only to visualize some data, a map, click through for a bit and get engaged. A scratch on the surface, a honest v0.1.0! 🎉

cmd/geneve/source_events.go

@@ -25,7 +25,7 @@ import (
 	"golang.org/x/mod/semver"
 )
 
-var Version = "0.0.3"
+var Version = "0.1.0"
 
 type SourceEvents struct {
 	o            *python.PyObject

geneve/__init__.py

@@ -17,4 +17,4 @@
 
 from .events_emitter import *  # noqa: F401, F403
 
-version = "0.0.3"
+version = "0.1.0"

setup.cfg

@@ -19,6 +19,8 @@
 name = geneve
 version = attr: geneve.version
 description = Generate data from languages and models
+long_description = file: CHANGES.md
+long_description_content_type = text/markdown
 url = https://github.com/elastic/geneve
 license = Apache 2.0
 license_file = LICENSE.txt