https://github.com/rdf-elixir/rdf-xml-ex

An implementation of RDF-XML for Elixir
https://github.com/rdf-elixir/rdf-xml-ex

elixir rdf rdf-xml xml

Last synced: 2 months ago
JSON representation

An implementation of RDF-XML for Elixir

• Host: GitHub
• URL: https://github.com/rdf-elixir/rdf-xml-ex
• Owner: rdf-elixir
• License: mit
• Created: 2020-11-06T09:15:52.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-07T13:50:06.000Z (6 months ago)
• Last Synced: 2024-10-07T19:47:34.278Z (4 months ago)
• Topics: elixir, rdf, rdf-xml, xml
• Language: Elixir
• Homepage:
• Size: 223 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


# RDF-XML.ex

[![Hex.pm](https://img.shields.io/hexpm/v/rdf_xml.svg?style=flat-square)](https://hex.pm/packages/rdf_xml)

[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/rdf_xml/)

[![License](https://img.shields.io/hexpm/l/rdf_xml.svg)](https://github.com/rdf-elixir/rdf-xml-ex/blob/master/LICENSE.md)

[![ExUnit Tests](https://github.com/rdf-elixir/rdf-xml-ex/actions/workflows/elixir-build-and-test.yml/badge.svg)](https://github.com/rdf-elixir/rdf-xml-ex/actions/workflows/elixir-build-and-test.yml)

[![Dialyzer](https://github.com/rdf-elixir/rdf-xml-ex/actions/workflows/elixir-dialyzer.yml/badge.svg)](https://github.com/rdf-elixir/rdf-xml-ex/actions/workflows/elixir-dialyzer.yml)

[![Quality Checks](https://github.com/rdf-elixir/rdf-xml-ex/actions/workflows/elixir-quality-checks.yml/badge.svg)](https://github.com/rdf-elixir/rdf-xml-ex/actions/workflows/elixir-quality-checks.yml)

An implementation of the [W3C RDF 1.1 XML](http://www.w3.org/TR/rdf-syntax-grammar/) serialization format for Elixir and [RDF.ex].

The API documentation can be found [here](https://hexdocs.pm/rdf_xml/). For a guide and more information about RDF.ex and it's related projects, go to .

## Features

- fully conforming RDF/XML implementation passing all the official tests (apart from the currently unsupported features below)

- reader/writer for [RDF.ex] with support for reading and writing to streams

## Limitations

- XML canonicalization of `rdf:XMLLiteral`s  (`rdf:parseType="Literal"`) is not supported

- xmlns for `rdf` to shorten the syntax terms is not supported

## Installation

The [RDF-XML.ex](https://hex.pm/packages/rdf_xml) Hex package can be installed as usual, by adding `rdf_xml` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [{:rdf_xml, "~> 1.1"}]

end

```

## Usage

RDF-XML.ex can be used to serialize or deserialize RDF data structures by using the RDF.ex reader and writer functions as usual.

```elixir

graph = RDF.XML.read_file!("file.rdf")

RDF.XML.write_file!(graph, "file.rdf")

```

Above the common options of all RDF.ex encoders and decoders, the encoder and decoder of RDF-XML.ex supports some additional options. See the [API documentation](https://hexdocs.pm/rdf_xml/) for information about the available options.

## Contributing

see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Acknowledgements

The development of this project was sponsored by [NetzeBW](https://www.netze-bw.de/) for [NETZlive](https://www.netze-bw.de/unsernetz/netzinnovationen/digitalisierung/netzlive).

## Consulting

If you need help with your Elixir and Linked Data projects, just contact [NinjaConcept](https://www.ninjaconcept.com/) via .

## License and Copyright

(c) 2020-present Marcel Otto. MIT Licensed, see [LICENSE](LICENSE.md) for details.

[RDF.ex]:             https://hex.pm/packages/rdf