Skip to content

Latest commit

 

History

History
79 lines (45 loc) · 2.03 KB

README.rst

File metadata and controls

79 lines (45 loc) · 2.03 KB

Google API Artifact Manager

Google API Artifact manager (artman) is a set of modules used to automate the creation of software artifacts related to APIS defined using protobuf IDL.

artman is an extensible framework that is responsible for creating all artifacts related to an API including

  • distribution packages in all supported programming languages
  • generic documentation websites
  • language-specific documentation websites (javadoc, readthedocs, etc)

from the protobuf source IDL and additional configuration in YAML files.

Installation

At the moment, this library is under development, so please see using a development checkout for installation instructions

Usage

Currently, this tool can only be run in the development environment of the development team, as some dependencies are yet to be published. See USAGE for details.

Python Versions

artman is currently tested with Python 2.7.

Contributing

Contributions to this library are always welcome and highly encouraged.

See the CONTRIBUTING documentation for more information on how to get started.

Versioning

This library follows Semantic Versioning

It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.

Details

For detailed documentation of the modules in artman, please watch DOCUMENTATION.

License

BSD - See LICENSE for more information.