Skip to main content

Introduction

simple_jinjamator is a simplified REST client for jinjamator

Features

simple_catalyst_center has following features:
  • manage login

  • download files

  • upload files

  • run tasks with environment support and basic enforcement of required parameters

  • wait for job results

  • check job status

  • CRUD interface for all possible API URLs

Installation

Install by running:

pip3 install simple_jinjamator

Examples

run a task and download all generated files

import os
import sys
from simple_jinjamator import JinjamatorClient
import logging
from getpass import getpass

base_url = input("Please Enter Jinjamator URL: ") or "http://localhost:5000"
username = input("Please Enter Jinjamator username: ") or "root"
password = getpass("Please Enter Jinjamator password: ") or "<not set>"

URL=f"{base_url}/api"

jm_client = JinjamatorClient(URL, ssl_verify=False)
print("login to jinjamator with username and password using the local aaa povider")
jm_client.login(username, password, "local")
api = jm_client.api

print("start job in environment some/env with the parameter command and get the job id")

job_id=jm_client.run("/tasks/jinjamator101/discover_cisco_device",environment="some/env",command="show interface status")

print("poll job status and wait for success or failure (default timeout is 300s, default pollrate=10s) ")
jm_client.wait_for_job(job_id)

print("download all generated files to /tmp")
jm_client.download_job_files(job_id,"/tmp")

for all options have a look at the JinjamatorClient class in simple_jinjamator/__init__.py

Contribute

Roadmap

Selected Roadmap items:
  • add more documentation

  • add some more examples

For documentation please refer to https://simple_jinjamator.readthedocs.io/en/latest/

License

This project is licensed under the Apache License Version 2.0

Metadata

Release files for simple-jinjamator 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for simple-jinjamator 0.1.1
File Interpreter ABI Platform Actions
simple_jinjamator-0.1.1-py3-none-any.whl Python 3 none any Details for simple_jinjamator-0.1.1-py3-none-any.whl

Release files / simple_jinjamator-0.1.1-py3-none-any.whl

Download URL simple_jinjamator-0.1.1-py3-none-any.whl
Size 15.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f12c7bc0d79752df0d83caaeeebf0680d9d399a5f8b01f5e3a24815dc2bf892c
BLAKE2b-256 checksum
How to use checksums
23abe04e907f5af2d0f3d319393e55afa598dc9b11d52c4b7977220d4f05637e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Security for simple-jinjamator 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page