pyro-dash-py 0.1.6

A python sdk for the pyro-dashboard-api

pyro_dash_py

A pretty light-weight and somewhat bearable python-sdk for the pyro-dashboard-api

Visit pyro_dash_py's full documentation here: https://pyrologix.github.io/pyro_dash_py/

Installation

pyro_dash_py has a public pypi package that you can install.

pip install pyro_dash_py

Speed Run Usage

First, initialize the PyroDash client, make sure you are specifying your own api key.

pyro = PyroDash(
    host="https://api.dashboard.pyrologix.com",
    email="[e-mail]",
    apikey="my-super-secret-key",
)

Now you can create some projects and jobs:

my_project = pyro.projects.create(name="Hello from pyro_dash_py")
my_job = pyro.jobs.create("wildest")

my_project.add_job(my_job.id)

For Contributors

This project uses poetry to manage dependencies and virtual environments. You're gonna need that.

You can follow the installation instructions here or you can just run the command below:

curl -sSL https://install.python-poetry.org | python3 -
source ~/.zshrc # or whatever shell you're using

Then you can clone this repo and install dependencies:

git clone https://github.com/pyrologix/pyro_dash_py.git
poetry install --with dev

# and you should be able to run the test suite
poetry run pytest

You are encouraged to check out the examples/ in order to get a feel for usage.

Docs

• poetry run mkdocs serve - Start the live-reloading docs server.
• poetry run mkdocs build - Build the documentation site.