https://github.com/bellyjay1005/pydroneapi

Python client for Drone CI API. Manages authentication against Drone CI and performs common Drone CI API operations using a Python wrapper.
https://github.com/bellyjay1005/pydroneapi

Last synced: 5 days ago
JSON representation

Python client for Drone CI API. Manages authentication against Drone CI and performs common Drone CI API operations using a Python wrapper.

• Host: GitHub
• URL: https://github.com/bellyjay1005/pydroneapi
• Owner: bellyjay1005
• License: mit
• Created: 2021-09-13T06:34:28.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-08T16:08:29.000Z (over 1 year ago)
• Last Synced: 2024-04-23T13:26:34.432Z (7 months ago)
• Language: Python
• Size: 74.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pydroneapi

[![Run Python Tests](https://github.com/bellyjay1005/pydroneci/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/bellyjay1005/pydroneci/actions/workflows/ci.yml)

[![Push to PyPi](https://github.com/bellyjay1005/pydroneci/actions/workflows/pypi.yml/badge.svg)](https://github.com/bellyjay1005/pydroneci/actions/workflows/pypi.yml)

[![Build and Push Docker Images](https://github.com/bellyjay1005/pydroneci/actions/workflows/docker.yml/badge.svg)](https://github.com/bellyjay1005/pydroneci/actions/workflows/docker.yml)

[![Build and Push Image to Githug Registry](https://github.com/bellyjay1005/pydroneci/actions/workflows/github.yml/badge.svg)](https://github.com/bellyjay1005/pydroneci/actions/workflows/github.yml)

[![Main Deploy](https://github.com/bellyjay1005/pydroneapi/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/bellyjay1005/pydroneapi/actions/workflows/main.yml)

[![Latest Version](https://pypip.in/version/pydroneapi/badge.svg)](https://pypi.org/project/pydroneapi/)

[![Download](https://pypip.in/download/pydroneapi/badge.svg)](https://pypi.org/project/pydroneapi/)

[![Status](https://pypip.in/status/pydroneapi/badge.svg)](https://pypi.org/project/pydroneapi/)

[![License](https://pypip.in/license/pydroneapi/badge.svg)](https://pypi.org/project/pydroneapi/)

A DRONE CI Server - Python helper scripts to manage API interactions and operations.

This tool manages authentication against Drone CI and performs common Drone CI API operations using a Python wrapper.

## Prerequisites

 - [Docker 18.09+](https://www.docker.com/)

 - Make

## Installation

From PyPI:

```

pip install pydroneapi

```

From source:

```

git clone --recursive https://github.com/bellyjay1005/pydroneapi

cd pydroneci

python setup.py install

```

From Github directly:

```

pip3 install pydroneapi@git+https://github.com/bellyjay1005/pydroneci

```

## Usage

#### Example:

```python

from pydroneapi import PyDroneAPI

# Sync application github repository with Drone pipeline

drone = PyDroneAPI(

    drone_host='https://example.com',

    token='abcd1234',

    repo='bellyjay1005/test-repo',

)

sync_res = drone.synchronize_repository()

if not sync_res[0]['id']:

    print('New Repository Not Synchronized. Error Message - %s', sync_res)

    return False

```

## Development & Test

Reference [make help](https://github.com/bellyjay1005/pydroneci/blob/main/Makefile) for more commands used for development and testing of source codes.