Google API artifact manager
Project description
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
Optional: set up a virtualenv for your Python work. Choose one of the following:
(recommended) virtualenvwrapper so you don’t have to keep track of where your virtualenv is on the filesystem:
sudo pip install virtualenv virtualenvwrapper mkvirtualenv --python=`which python3` artmanTo use this virtual environment later:
workon artmanvirtualenv in your current directory:
sudo pip install virtualenv virtualenv env source env/bin/activate
Install artman directly from pip:
pip install googleapis-artman
You may need root privileges if you are not installing inside of a virtualenv. This will make the artman command available on your system.
Prerequisites
Install googleapis
Install toolkit
Install Java
Some languages may have additional dependencies; refer to the Dockerfile in this repository for canonical installation requirements.
Usage
Before you can use artman, you will need a configuration file. You can run configure-artman to create a simple configuration file.
For building a GAPIC (the most common task), the usage looks like:
artman --api pubsub --language pythonArtman also takes a --publish argument to decide where to stage the code. Using --publish github will create a pull request on GitHub automatically.
Python Versions
artman is currently tested with Python 2.7, Python 3.4, Python 3.5, and Python 3.6.
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
