Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guardian/nitf-scala
Scala library to parse and generate News Industry Text Format files
https://github.com/guardian/nitf-scala
nitf production scala xml-generator xml-parser
Last synced: 27 days ago
JSON representation
Scala library to parse and generate News Industry Text Format files
- Host: GitHub
- URL: https://github.com/guardian/nitf-scala
- Owner: guardian
- License: apache-2.0
- Created: 2018-03-02T17:06:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-10T10:02:26.000Z (about 2 years ago)
- Last Synced: 2024-09-30T02:05:08.753Z (about 1 month ago)
- Topics: nitf, production, scala, xml-generator, xml-parser
- Language: Scala
- Homepage:
- Size: 249 KB
- Stars: 1
- Watchers: 48
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# nitf-scala
[](https://github.com/guardian/nitf-scala/blob/master/LICENSE)
[](https://travis-ci.org/guardian/nitf-scala)
[](https://www.codacy.com/app/hosamaly/nitf-scala?utm_source=github.com&utm_medium=referral&utm_content=guardian/nitf-scala&utm_campaign=Badge_Grade)
[](https://mvnrepository.com/artifact/com.gu/nitf-scala)
[](https://mvnrepository.com/artifact/com.gu/nitf-scala)
Scala library to parse and generate [News Industry Text Format](https://iptc.org/standards/nitf/) files,
based on [ScalaXB](http://scalaxb.org).
This library supports versions 3.3 to 3.6.
(Previous versions don't have an XSD.)
## Usage
To use this library, add the following dependencies to your project:
```scala
val nitfScalaVersion = "3.6.2" // one of 3.3, 3.4, 3.5, and 3.6 followed by the release version
val scalaXmlVersion = "1.1.0"
libraryDependencies ++= Seq(
"org.scala-lang.modules" %% "scala-xml" % scalaXmlVersion,
"org.scala-lang.modules" %% "scala-parser-combinators" % scalaXmlVersion,
"com.gu" %% "nitf-scala" % nitfScalaVersion
)
```
This is an example of how to parse XML into NITF:
```scala
import com.gu.nitf.model._
import com.gu.nitf.scalaxb._
val doc = scalaxb.fromXML[Nitf](
Hello
World
)
```
This is an example of how to create an NITF tree:
```scala
import com.gu.nitf.model.builders._
val doc = new NitfBuilder()
.withHead(new HeadBuilder().withTitle("News Article"))
.withBody(new BodyBuilder()
.withContent(new BodyContentBuilder()
.withParagraph(new ParagraphBuilder().withText("That's it, really!"))
))
.build
val xml = scalaxb.toXML(doc, None, None, BareNitfNamespace)
```
## Specifications
NITF schema, documentation, and examples are available from IPTC.
[This archive](http://www.iptc.org/std/NITF/NITF.zip) contains all of this for versions 2.5 to 3.6.
The schemas used to generate the classes in this project are available in the [schema](schema) folder.
## Generated Sources
The source files were generated using an
[unreleased version of ScalaXB](https://github.com/hosamaly/scalaxb/archive/451e9c59a3ed347c75e0d1d3924ee1be0e1939c6.zip)
that was built from source. Hopefully, it will be released in the main repository soon.
The following command was used to generate the files:
```bash
for v in 3.{3..6}; do
scalaxb "src/test/resources/nitf-$v.xsd" \
--outdir "src/main/$v" \
--no-dispatch-client \
--named-attributes \
--capitalize-words \
--symbol-encoding-strategy=discard \
--default-package com.gu.nitf.model \
--protocol-package com.gu.nitf.scalaxb
done
```
## Building
To build this project from source, run:
```bash
sbt clean +compile +test
```
Note that a clean build may take up to 10 minutes.
You may also need to increase the memory available to sbt (e.g. using `-mem`).
(The full compilation has more than 24k class files!)
The project is set up to build against Scala 2.11 and Scala 2.12.