rdf-ex/README.md

62 lines
2.5 KiB
Markdown
Raw Normal View History

2017-06-11 12:32:26 +00:00
# RDF.ex
2017-06-25 19:13:13 +00:00
[![Travis](https://img.shields.io/travis/marcelotto/rdf-ex.svg?style=flat-square)](https://travis-ci.org/marcelotto/rdf-ex)
[![Hex.pm](https://img.shields.io/hexpm/v/rdf.svg?style=flat-square)](https://hex.pm/packages/rdf)
2017-06-25 22:37:29 +00:00
[![Inline docs](http://inch-ci.org/github/marcelotto/rdf-ex.svg)](http://inch-ci.org/github/marcelotto/rdf-ex)
2017-06-25 19:13:13 +00:00
2017-06-11 12:32:26 +00:00
An implementation of the [RDF](https://www.w3.org/TR/rdf11-primer/) data model in Elixir.
2016-09-30 14:36:50 +00:00
2019-04-06 00:24:22 +00:00
For more about RDF.ex and it's related projects, go to <https://rdf-elixir.dev>.
2017-06-24 22:25:07 +00:00
## Features
2017-07-05 21:27:55 +00:00
- fully compatible with the RDF 1.1 specification
2017-06-24 22:25:07 +00:00
- in-memory data structures for RDF descriptions, RDF graphs and RDF datasets
2018-09-17 01:26:40 +00:00
- ability to execute SPARQL queries against the in-memory data structures via the [SPARQL.ex] package or against any SPARQL endpoint via the [SPARQL.Client] package
- support for RDF vocabularies via Elixir modules for safe, i.e. compile-time checked and concise usage of IRIs
2017-06-24 22:25:07 +00:00
- XML schema datatypes for RDF literals (not yet all supported)
- sigils for the most common types of nodes, i.e. IRIs, literals, blank nodes and lists
- a description DSL resembling Turtle in Elixir
2017-07-31 21:21:09 +00:00
- implementations for the [N-Triples], [N-Quads] and [Turtle] serialization formats
2018-03-10 00:47:04 +00:00
- [JSON-LD] is implemented in the separate [JSON-LD.ex] package
2016-09-30 14:51:59 +00:00
2016-09-30 14:36:50 +00:00
2019-04-06 00:24:22 +00:00
## Contributing
2016-11-27 14:17:20 +00:00
2017-06-24 22:25:07 +00:00
There's still much to do for a complete RDF ecosystem for Elixir, which means there are plenty of opportunities for you to contribute. Here are some suggestions:
- more serialization formats
- [RDFa]
- [RDF-XML]
2017-07-05 21:27:55 +00:00
- [N3]
2017-06-24 22:25:07 +00:00
- et al.
2018-03-10 00:47:04 +00:00
- more XSD datatypes
2017-06-24 22:25:07 +00:00
- improve documentation
2016-11-27 14:17:20 +00:00
2019-04-06 00:24:22 +00:00
see [CONTRIBUTING](CONTRIBUTING.md) for details.
2016-11-27 14:17:20 +00:00
2019-04-06 00:24:22 +00:00
## Consulting and Partnership
2016-11-27 14:17:20 +00:00
2019-04-08 18:55:16 +00:00
If you need help with your Elixir and Linked Data projects, just contact <info@cokron.com> or visit <https://www.cokron.com/kontakt>
2016-11-27 14:17:20 +00:00
2016-11-27 14:17:20 +00:00
## License and Copyright
2019-07-14 23:14:40 +00:00
(c) 2017-2019 Marcel Otto. MIT Licensed, see [LICENSE](LICENSE.md) for details.
2017-06-24 22:25:07 +00:00
[RDF.ex]: https://hex.pm/packages/rdf
2018-05-15 19:39:52 +00:00
[JSON-LD.ex]: https://hex.pm/packages/json_ld
[SPARQL.ex]: https://hex.pm/packages/sparql
2018-05-15 19:39:52 +00:00
[SPARQL.Client]: https://hex.pm/packages/sparql_client
2017-06-24 22:25:07 +00:00
[N-Triples]: https://www.w3.org/TR/n-triples/
[N-Quads]: https://www.w3.org/TR/n-quads/
[Turtle]: https://www.w3.org/TR/turtle/
[N3]: https://www.w3.org/TeamSubmission/n3/
2017-07-31 21:21:09 +00:00
[JSON-LD]: http://www.w3.org/TR/json-ld/
[RDFa]: https://www.w3.org/TR/rdfa-syntax/
2017-06-24 22:25:07 +00:00
[RDF-XML]: https://www.w3.org/TR/rdf-syntax-grammar/