simplexspatial / osm4scala

Scala and Spark library focused on reading OpenStreetMap Pbf files.

Version Matrix

osm4scala

Maven Central Build Status Coverage Status Quality Gate Status Gitter MIT licensed FOSSA Status Contributor Covenant

High performance Scala library and Spark Polyglot (Scala, Python, SQL, etc.) connector for OpenStreetMap Pbf files.

Documentation and site

Full documentation at https://simplexspatial.github.io/osm4scala/

Dev information:

Reminder: Only '+' will trigger cross versions.

Prepare environment

It's possible to develop using a Windows machine, but all documentation suppose that you are using Linux or Mac.

The only special requirement is to execute sbt compile to generate the protobuf source code.

sbt compile

Release process

The publication into Maven Central has been removed from the release process, so now there are few steps:

  1. Release.
    git checkout master
    sbt release
  2. Publish into Maven Central. Info at xerial/sbt-sonatype After set the right credentials file at $HOME/.sbt/1.0/sonatype.sbt:
    git checkout v1.*.*
    sbt clean
    PATCH_211=false sbt +publishSigned
    PATCH_211=true sbt +publishSigned
    # In this point, tree target/sonatype-staging/ will show all artifacts to publish.
    sbt sonatypeBundleRelease
  3. Publish documentation and site.
    git checkout v1.*.*
    cd website
    nvm use
    export GIT_USER=<username>; export USE_SSH=true; npm run deploy

References.

PBF information:

third party OSS libraries: