Skip to content

starwit/vision-api

Repository files navigation

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>3.0.0</version>
    </dependency>

How-To Update

  1. Make desired changes in ./visionapi
  2. Run make
  3. Make sure that there are no old leftover files in the generated projects
  4. 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