adop 0.0.9

Summary

Automatic deployment on-prem from zip archives.

Features

• A REST API to upload, download and deploy zip-files.

• Listens for webhook requests, to continuously deploy zip-files on commits.

• Includes “package manager” like commands to upload and installing zip-files.

Warning

• This is a beta version. Not ready for production.

Installation

Open command line and and install using pip:

$ pip install adop[server]

Usage

adop is available as console script and library module

$ adop -h
$ python -m adop -h

Serve the REST-API:

$ adop serve-api
Serving on http://127.0.0.1:8000

Find the generated authorization token

• Windows

  > type %USERPROFILE%\.adop\adop.ini | findstr write_token

• Linux

  $ cat ~/.adop/adop.ini | grep write_token

Test the REST-API with curl

• Windows

  > set ADOP_TOKEN=copy-paste-token-here
  > curl -H "Token: %ADOP_TOKEN%" "http://127.0.0.1:8000/api/v1/test"

• Linux

  $ export ADOP_TOKEN=copy-paste-token-here
  $ curl -H "Token: $ADOP_TOKEN" "http://127.0.0.1:8000/api/v1/test"

Upload and deploy a zip-library:

$ curl \
  -H "Token: $ADOP_TOKEN" \
  -H "Zip-Tag: 0.1.0" \
  --data-binary "@work/mylib.zip" \
  "http://127.0.0.1:8000/api/v1/deploy/zip/mylib"

Zip file layout

Zip files with exactly one root directory are valid and can be distributed. The root directory name must be unique if many zip files are to be distributed.

Example of a valid zip file layout:

/mylib/
    /README.rst
    /main.py
    /mypackage1/
        /__init__.py
        /__main__.py
    /mypackage2/
        /__init__.py
        /__main__.py

Following example is not valid:

/README.rst
/mylib1/
    /__init__.py
    /__main__.py
/mylib2/
    /__init__.py
    /__main__.py

API

$ curl \
  -H "Token: paste-token-here" \
  http://127.0.0.1:8000/api/v1/test
{
  "result": "It works",
  "result_code": 0
}

$ curl \
  -H "Token: paste-token-here" \
  --data-binary "@work/mylib.zip" \
  http://127.0.0.1:8000/api/v1/deploy/zip/mylib
// root: mylib
// store data
// verify data
// verify root dir
// verify zip data
// zip root: 'mylib'
// unpack zip data
// remove untracked files
{"root": "mylib", "result": "Success", "result_code": 0}

$ curl \
  -H "Token: paste-token-here" \
  --data-binary "@work/mylib.zip" \
  http://127.0.0.1:8000/api/v1/deploy/zip/mylib \
  | grep -v // \
  | python -m json.tool
{
    "root": "mylib",
    "result": "Success",
    "result_code": 0
}

Client side

Define requirements in a requires.ini file

[requires]
mylib = tag:0.1.0

Define the remote and install locations:

$ export ADOP_TOKEN=copy-paste-token-here
$ adop config add-remote myserver http://127.0.0.1:8000/api/v1 -e ADOP_TOKEN
$ adop config add-install mylibs ./lib/auto ./lib/.cache

And then install:

$ adop zip install requires.ini --remote myserver --install mylibs