Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ansible/galaxykit

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/ansible/galaxykit
Owner: ansible
License: other
Created: 2021-06-10T15:24:34.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-05-22T17:03:52.000Z (4 months ago)
Last Synced: 2024-05-23T07:07:13.652Z (4 months ago)
Language: Python
Size: 332 KB
Stars: 9
Watchers: 28
Forks: 15
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.md

## Galaxykit

Galaxykit is a client library for [galaxy\_ng](https://github.com/ansible/galaxy_ng), designed for use in internal testing.

It's intended to be a low-dependency and low-abstraction client for performing actions on a remote Automation Hub or galaxy\_ng instance.

### Prerequisites

[Ansible](https://github.com/ansible/ansible).

```pip3 install ansible```

### Installing:

To install the latest development version, run `pip3 install -e .` in the root of your checked-out copy of this repository.

To set up the pre-commit hooks we are using (currently just autoformatting with `black`), run the following snippet:

```bash
pre-commit install
pre-commit install-hooks
```

After running those commands, make sure to run the following command to the latest unreleased version:

```pip3 install ansible git+https://github.com/ansible/galaxykit.git@master```

After that's been done, the first commit you make will have to install any of those dependencies, and may take a few minutes.

### Distributing

To build a distribution package you need to install `build` tool, a build-backend agnostic and standartized tool
for building dictrubiton packages.

```shell
pip install build
```

After installation, execute it as following:

```shell
python -m build
```