Skip to main content

ogc, a runner of things

Project description

Build Status

OGC, a runner of things

ogc - Task runner with a focus on deployment/testing/reporting.

Description

OGC is powered by plugins that can be discovered on https://pypi-hypernode.com with the prefix of ogc-plugins. With plugins installed different aspects of a run can be defined through a spec file, which is a yaml file setting up plugin configuration for the particular goal.

Usage

> pip install ogc
> ogc --spec ogc-spec-runner.yml execute

# Or with a ogc.yml file in same directory running ogc from
> ogc execute

Add plugins

To make OGC a bit more useful, install a few plugins:

> pip install ogc-plugins-runner
> pip install ogc-plugins-env

This will allow you to add functionality such as running scripts and preparing environment variables. Please see the plugins section of the docs for more information.

meta:
  name: A test spec
  description: A simple spec showing how to run commands

# Phases
setup:
  - runner:    # This is the plugin from ogc-plugins-runner
      description: Clean out build directory
      cmd: rm -rf build
      tags: [clean]

Show plugin dependencies

OGC doesn't install plugin dependencies automatically, but will give you a summary that you can pass to whatever automation strategy you want.

> ogc --spec ogc-spec-runner.yml list-deps

Output:

Plugin dependency summary ::

  - apt:python3-markdown
  - snap:juju/latest/stable:classic
  - snap:juju-wait/latest/stable:classic
  - pip:pytest==5.0.1

To get the install commands for the plugin deps you can pass --installable:

> ogc --spec ogc-spec-runner.yml list-deps --installable

Output:

sudo apt install -qyf python3-markdown
sudo snap install juju --channel=latest/stable --classic
sudo snap install juju-wait --channel=latest/stable --classic
pip install --user pytest==5.0.1

Or to handle installing those packages automatically (like in a CI run):

> ogc --spec ogc-spec-runner.yml list-deps --installable | sh -

More information

Project details


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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

ogc-0.3.19-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file ogc-0.3.19-py3-none-any.whl.

File metadata

  • Download URL: ogc-0.3.19-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.3

File hashes

Hashes for ogc-0.3.19-py3-none-any.whl
Algorithm Hash digest
SHA256 388fe1afb70db006287b3f73ffecd2c275f6a2b7ef96cc5c3e0bbad175ace02d
MD5 47b096d95b919346fe903c7002365ec5
BLAKE2b-256 660f332190cd2a52546acdd77d6b1e56a7047e89ee4d600ae3d70ab8b1b74475

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page