Giter Club home page Giter Club logo

artman's Introduction

Google API Artifact Manager

Google API Artifact Manager (artman) is a program used to automate the generation and publishing of API client libraries.

In order to be consumed by artman, APIs require:

  • A Protocol Buffers description of the API, specified using proto3 syntax.
  • A service configuration stub. This is YAML configuration which designates how the API is housed within Google's infrastructure.
  • A GAPIC configuration. This provides extra information specific to generating a client library.
  • An artman configuration. This is the file artman uses as the entry point, and it points to the previous items in this list.

The artman tool is a wrapper around toolkit; it takes the configuration enumerated above, normalizes it, and sends it to toolkit, which generates a client library on disk, and then artman performs some concluding cleanup.

Client libraries produced in this way are executable "out of the box", and include basic reference documentation, and appropriate packaging and metadata files.

Installing

If your goal is just to use artman (rather than contribute to it), a standard pip install is probably not the right thing; we recommend the use of pipsi instead.

View our installation guide to get going.

Documentation

Documentation is available on Read the Docs.

artman's People

Contributors

alexander-fenster avatar andreamlin avatar anupkumarpanwar avatar bcoe avatar busunkim96 avatar chingor13 avatar chrisdunelm avatar eoogbe avatar ethanbao avatar garrettjonesgoogle avatar geigerj avatar jbolinger avatar jmuk avatar jskeet avatar justinbeckwith avatar landrito avatar lukesneeringer avatar michaelbausor avatar mvashishtha avatar neozwu avatar noahdietz avatar pongad avatar renovate-bot avatar saicheems avatar shinfan avatar software-dov avatar tbetbetbe avatar vam-google avatar vchudnov-g avatar yihanzhen avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.