Skip to content

Commit

Permalink
General repo cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
lszeremeta committed Feb 3, 2024
1 parent ccf3547 commit 95441d5
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 1,013 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2018-2023, Łukasz Szeremeta
Copyright (c) 2018-2024, Łukasz Szeremeta
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
# YARS-PG grammar

[![Test and pre-release](https://github.com/lszeremeta/yarspg/actions/workflows/pre-release.yml/badge.svg)](https://github.com/lszeremeta/yarspg/actions/workflows/pre-release.yml)
[![DOI](https://zenodo.org/badge/161351716.svg)](https://zenodo.org/badge/latestdoi/161351716)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/lszeremeta/yarspg/pre-release.yml?label=Test%20and%20pre-release)](https://github.com/lszeremeta/yarspg/actions/workflows/pre-release.yml) [![GitHub Release](https://img.shields.io/github/v/release/lszeremeta/yarspg)](https://github.com/lszeremeta/yarspg/releases/latest) [![DOI](https://zenodo.org/badge/161351716.svg)](https://zenodo.org/badge/latestdoi/161351716)

The YARS-PG serialization is a special version of [YARS](https://github.com/lszeremeta/yars) for property graphs. This serialization is specially designed for property graphs:
The YARS-PG serialization is designed for property graphs (but not only):
* YARS-PG supports all the features allowed by the current database systems based on the property graph data model,
* YARS-PG provides a simple syntax with a reduced number of extra characters,
* YARS-PG is inspired by the syntax used by popular graph query languages (e.g. Cypher and GQL) to encode the structure of a property graph (i.e. nodes, edges, and properties).

The YARS-PG grammar is written in [ANTLR4](https://github.com/antlr/antlr4). If you prefer [Extended Backus-Naur Form (EBNF)](https://www.w3.org/TR/REC-xml/#sec-notation) notation, you can also see a preview version of [YARS-PG grammar in EBNF](https://github.com/lszeremeta/antlr-yarspg/blob/main/other-notations/YARSpg.ebnf). See [YARS-PG specification](https://lszeremeta.github.io/yarspg/index.html) or detailed [Serialization for Property Graphs presentation](https://www.researchgate.net/publication/340208659_Serialization_for_Property_Graphs) for more details.

This project is based on the [ANTLR grammars-v4 project](https://github.com/antlr/grammars-v4).
The YARS-PG grammar is written in [ANTLR4](https://github.com/antlr/antlr4). If you prefer [Extended Backus-Naur Form (EBNF)](https://www.w3.org/TR/REC-xml/#sec-notation) notation, you can also see [YARS-PG grammar in EBNF](https://github.com/lszeremeta/antlr-yarspg/blob/main/other-notations/YARSpg.ebnf). You may also see YARS-PG [examples](https://github.com/lszeremeta/yarspg/tree/main/yarspg/examples).

## Parsers

Expand All @@ -20,7 +17,7 @@ The YARS-PG parsers are available in the [parsers](https://github.com/lszeremeta

If you want to help build YARS-PG parsers for other languages, please follow the [ANTLR4 documentation](https://github.com/antlr/antlr4/tree/dev/doc) and create a pull request.

See the ``README.md`` file in each parser directory for more details. Ready to use parsers are also available in the Assets section in [Releases](https://github.com/lszeremeta/yarspg/releases).
See the ``README.md`` file in each parser directory for more details. Ready-to-use parsers are also available in the Assets section in [Releases](https://github.com/lszeremeta/yarspg/releases).

## Testing grammar

Expand All @@ -30,6 +27,8 @@ Run tests on files in ``yarspg/examples``:
mvn clean test
```

This project is based on the [ANTLR grammars-v4 project](https://github.com/antlr/grammars-v4).

## Contribution

Would you like to improve this project? Great! We are waiting for your help and suggestions. If you are new to open source contributions, read [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).
Expand Down
Loading

0 comments on commit 95441d5

Please sign in to comment.