Vision API repository

This repo contains the main data model for the Starwit Awareness Engine (SAE). See umbrella repo here: https://github.com/starwit/starwit-awareness-engine

How-To Use

Java / Maven

• Add maven repository to your ~/.m2/settings.xml (adapt example / your config as necessary):

  <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
  
  <activeProfiles>
      <activeProfile>github</activeProfile>
  </activeProfiles>
  
  <profiles>
      <profile>
      <id>github</id>
      <repositories>
          <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2</url>
          </repository>
          <repository>
          <id>github</id>
          <url>https://maven.pkg.github.com/starwit/vision-api</url>
          <snapshots>
              <enabled>true</enabled>
          </snapshots>
          </repository>
      </repositories>
      </profile>
  </profiles>
  
  <servers>
      <server>
          <id>github</id>
          <username>YOUR_GITHUB_USER</username>
          <password>GITHUB_TOKEN_WITH_PACKAGE_READ_PERMISSIONS</password>
      </server>
  </servers>
  </settings>
  

• Add dependency to your project:

  <dependency>
    <groupId>de.starwit</groupId>
    <artifactId>vision-api</artifactId>
    <version>2.0.1</version>
  </dependency>

How-To Update

1. Make desired changes in ./visionapi
2. If you have added or deleted *.proto files in step 1, adapt the Rust related files accordingly (in the Makefile and build.rs)
3. Run make
4. Make sure that there are no old leftover files in the generated projects
5. Increment the package versions of all files
   • ./rust/Cargo.toml
   • ./python/pyproject.toml
   • ./java/pom.xml
6. Commit, tag with version and push

   // Commit stuff, like git add, git commit and such
   git tag <version_tag>
   git push
   git push <version_tag>
   

Tools & Setup

ProtoBuf compiler can be downloaded here: https://github.com/protocolbuffers/protobuf/releases