https://github.com/tinvaan/drone-python

Python client for the drone.io public API
https://github.com/tinvaan/drone-python

Last synced: 5 days ago
JSON representation

Python client for the drone.io public API

• Host: GitHub
• URL: https://github.com/tinvaan/drone-python
• Owner: tinvaan
• License: apache-2.0
• Created: 2020-06-25T23:02:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-01T01:55:44.000Z (about 1 year ago)
• Last Synced: 2024-07-04T21:01:57.109Z (4 months ago)
• Language: Python
• Size: 23.4 KB
• Stars: 16
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# drone-python  [![Build Status](https://cloud.drone.io/api/badges/tinvaan/drone-python/status.svg)](https://cloud.drone.io/tinvaan/drone-python)

Python client for the [Drone CI](https://cloud.drone.io) public [remote api](https://readme.drone.io/api/overview/) built using the popular [python requests](https://pypi.org/project/requests/) library.

## Installation

* Using Python package manager (pip)

  ```bash

  $ pip install drone-python

  ```

* From source  

Ensure you have a working installation of Python 3.x on your system.  

Clone the repository and run the setup script provided.

  ```bash

  $ git clone [email protected]:tinvaan/drone-python.git

  $ cd drone-python

  $ python setup.py install

  ```

## Environment

Ensure you have the `DRONE_TOKEN` and optionally, the `DRONE_SERVER` environment variables setup correctly.

```bash

$ export DRONE_SERVER="https://cloud.drone.io"

$ export DRONE_TOKEN="

```

## Usage examples

Fetch all linked repos

```python

>>> from drone import drone

>>> client = drone('tinvaan', 'packager')

>>> client.repos.all()

[{'id': 799963,

  'uid': '45485693',

  'user_id': 0,

  'namespace': 'tinvaan',

  'name': 'Algorithms',

  'slug': 'tinvaan/Algorithms',

    ...

    ...

  'version': 1},

    ...

    ...

    ...

 {'id': 7993143,

  'uid': '1897133997',

  'user_id': 0,

  'namespace': 'tinvaan',

  'name': 'zeit-logdna',

  'slug': 'tinvaan/zeit-logdna',

    ...

    ...

  'version': 1}]

```

Add a new secret

```python

>>> secret = {

        'name': 'testsecret',

        'data': 'mysecretvalue',

        'pull_request': False

   }

>>> client.secret.create(**secret)

{'id': 55114, 'repo_id': 7134978, 'name': 'testsecret'}

```

Fetch all builds for a repository

```python

>>> client.build.all()

[{'id': 342416, ... 'version': 3},

 {'id': 342400, ... 'version': 3},

 {'id': 341144, ... 'version': 3}]

```

## Contribute

If you notice any issues, bugs or missing features in this project, please feel free to open tickets(github issues) or pull requests for the same.

If you would like to contribute code, check out the open issues and if you need help getting started, shoot a mail to [email protected]