openjd-cli

v0.4.4

Provides a command-line interface for working with Open Job Description templates. For more information about how to use this package see README

Latest version published 4 months ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

75 / 100

security
No known security issues
popularity
Limited
maintenance
Healthy
community
Active

Popularity

Limited

GitHub Stars: 14
Forks: 7
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package openjd-cli, we found that it has been starred 14 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jul 23, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like openjd-cli is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 3
Open PR: 3
Last Release: 4 months ago
Last Commit: 12 days ago

Further analysis of the maintenance status of openjd-cli based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that openjd-cli demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the openjd-cli repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.9

Age: 1 year
Latest Release: 4 months ago
Dependencies: 0 Direct
Versions: 6
Maintainers: 2
Wheels: OS Independent

Readme

Open Job Description - CLI

Open Job Description (OpenJD) is a flexible open specification for defining render jobs which are portable between studios and render solutions. This package provides a command-line interface that can be used to validate OpenJD templates, run OpenJD jobs locally, and more.

For more information about Open Job Description and our goals with it, please see the Open Job Description Wiki on GitHub.

Compatibility

This library requires:

Python 3.9 or higher;
Linux, MacOS, or Windows operating system;
On Linux/MacOS:
- sudo

Versioning

This package's version follows Semantic Versioning 2.0, but is still considered to be in its initial development, thus backwards incompatible versions are denoted by minor version bumps. To help illustrate how versions will increment during this initial development stage, they are described below:

The MAJOR version is currently 0, indicating initial development.
The MINOR version is currently incremented when backwards incompatible changes are introduced to the public API.
The PATCH version is currently incremented when bug fixes or backwards compatible changes are introduced to the public API.

Contributing

We encourage all contributions to this package. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please see CONTRIBUTING.md for our contributing guidelines.

Commands

Getting Help

The main openjd command and all subcommands support a --help option to display information on how to use the command.

`check`

Validates, or reports any syntax errors that appear in the schema of a Job Template file.

Arguments

Name	Type	Required	Description	Example
`path`	path	yes	A path leading to a Job or Environment template file.	`/path/to/template.json`
`--output`	string	no	How to display the results of the command. Allowed values are `human-readable` (default), `json`, and `yaml`.	`--output json`, `--output yaml`

Example

$ openjd check /path/to/job.template.json

Template at '/path/to/job.template.json' passes validation checks!

`summary`

Displays summary information about a sample Job or Step, and the Steps and Tasks therein. The user may provide parameters to customize the Job, as parameters can have an impact on the amount of Steps and Tasks that a job consists of.

Arguments

Name	Type	Required	Description	Example
`path`	path	yes	A path leading to a Job template file.	`/path/to/job.template.json`
`--job-param`, `-p`	string, path	no	The values for the job template's parameters. Can be provided as key-value pairs, inline JSON string, or path(s) to a JSON or YAML document. If provided more than once then the given values are combined in the order that they appear.	`--job-param MyParam=5`, `-p file://parameter_file.json`, `-p '{"MyParam": "5"}'`
`--step`	string	no	The name of the Step to summarize.	`--step Step1`
`--output`	string	no	How to display the results of the command. Allowed values are `human-readable` (default), `json`, and `yaml`.	`--output json`, `--output yaml`

Example

$ openjd summary /path/to/job.template.json \
    --job-param JobName=SampleJob \
    --job-param '{"FileToRender": "sample.blend"}' \
    --job-param file://some_more_parameters.json

--- Summary for 'SampleJob' ---

Parameters:
    - JobName (STRING): SampleJob
    - FileToRender (PATH): sample.blend
    - AnotherParameter (INT): 10

Total steps: 2
Total tasks: 15
Total environments: 0

--- Steps in 'SampleJob' ---

1. 'Step1'
    1 Task parameter(s)
    10 total Tasks

2. 'Step2'
    2 Task parameter(s)
    5 total Tasks

`run`

Given a Job Template, Job Parameters, and optional Environment Templates this will run a set of the Tasks from the constructed Job locally within an OpenJD Sesssion.

Please see How Jobs Are Run for details on how Open Job Description's Jobs are run within Sessions.

Arguments

Name	Type	Required	Description	Example
`path`	path	yes	A path leading to a Job template file.	`/path/to/job.template.json`
`--step`	string	yes	The name of the Step to run in a local Session.	`--step Step1`
`--environment`	paths	no	Path to a file containing Environment Template definitions. Can be provided multiple times.	`--environment /path/to/env.template1.json --environment /path/to/env.template2.yaml`
`--job-param`, `-p`	string, path	no	The values for the job template's parameters. Can be provided as key-value pairs, inline JSON string, or as path(s) to a JSON or YAML document. If provided more than once then the given values are combined in the order that they appear.	`--job-param MyParam=5`, `-p file://parameter_file.json`, `-p '{"MyParam": "5"}'`
`--task-param`, `-tp`	string	no	Instructs the command to run a single task in a Session with the given value for one of the task parameters. The option must be provided once for each task parameter defined for the Step, with each instance providing the value for a different task parameter. Mutually exclusive with `--tasks` and `--maximum-tasks`.	`-tp MyParam=5 -tp MyOtherParam=Foo`
`--tasks`	string, path	no	Instructs the command to run one or more tasks for the Step in a Session. The argument must be either the filename of a JSON or YAML file containing an array of maps from task parameter name to value; or an inlined JSON string of the same. Mutually exclusive with `--task-param/-tp` and `--maximum-tasks`.	`--tasks '[{"MyParam": 5}]'`, `--tasks file://parameter_set_file.json`
`--maximum-tasks`	integer	no	A maximum number of Tasks to run from this Step. Unless present, the Session will run all Tasks defined in the Step's parameter space or the Task(s) selected by the `--task-param` or `--tasks` arguments. Mutually exclusive with `--task-param/-tp` and `--tasks`.	`--maximum-tasks 5`
`--run-dependencies`	flag	no	If present, runs all of a Step's dependencies in the Session prior to the Step itself.	`--run-dependencies`
`--path-mapping-rules`	string, path	no	The path mapping rules to apply to the template. Should be a JSON-formatted list of Open Job Description path mapping rules, provided as a string or a path to a JSON/YAML document prefixed with 'file://'.	`--path-mapping-rules [{"source_os": "Windows", "source_path": "C:\test", "destination_path": "/mnt/test"}]`, `--path-mapping-rules file://rules_file.json`
`--preserve`	flag	no	If present, the Session's working directory will not be deleted when the run is completed.	`--preserve`
`--verbose`	flag	no	If present, then verbose logging will be enabled in the Session's log.	`--verbose`
`--output`	string	no	How to display the results of the command. Allowed values are `human-readable` (default), `json`, and `yaml`.	`--output json`, `--output yaml`

Example

$ openjd run /path/to/job.template.json --step Step1 \
    --job-param PingServer=amazon.com \
    --task-param PingCount=20 \
    --task-param PingDelay=30

# ... Task logs accompanied by timestamps ...

--- Results of local session ---

Session ended successfully
Job: MyJob
Step: Step1
Duration: 1.0 seconds
Tasks run: 1

`schema`

Returns the Open Job Description model as a JSON schema document body.

Arguments

Name	Type	Required	Description	Example
`--version`	string	yes	The specification version to get the JSON schema for.	`--version jobtemplate-2023-09`
`--output`	string	no	How to display the results of the command. Allowed values are `human-readable` (default), `json`, and `yaml`.	`--output json`, `--output yaml`

Example

$ openjd schema --version jobtemplate-2023-09

{
    "title": "JobTemplate",
    # ... JSON body corresponding to the Open Job Description model schema ...
}

Downloading

You can download this package from:

Verifying GitHub Releases

You can verify the authenticity of the release artifacts using the gpg command line tool.

Download the desired release artifacts from the GitHub releases page. Make sure to download the corresponding PGP signature file (ending with .sig) as well. For example, if you would like to verify your download of the wheel for version 1.2.3, you should have the following files downloaded:
```
openjd_cli-1.2.3-py3-none-any.whl
openjd_cli-1.2.3-py3-none-any.whl.sig
```
Install the gpg command line tool. The installation process varies by operating system. Please refer to the GnuPG website for instructions: https://gnupg.org/download/

Save the following contents to a file called openjobdescription-pgp.asc:

Import the OpenPGP key for Open Job Description by running the following command:
```
gpg --import --armor openjobdescription-pgp.asc
```

Determine whether to trust the OpenPGP key. Some factors to consider when deciding whether or not to trust the above key are:

The internet connection you’ve used to obtain the GPG key from this website is secure
The device that you are accessing this website on is secure

If you have decided to trust the OpenPGP key, then edit the key to trust with gpg like the following example:

$ gpg --edit-key A2F0F059BCC40987
gpg (GnuPG) 2.0.22; Copyright (C) 2013 Free Software Foundation, Inc.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.


pub  4096R/BCC40987  created: 2024-02-09  expires: 2026-02-08  usage: SCEA
                     trust: unknown       validity: unknown
[ unknown] (1). Open Job Description 

gpg&gt; trust
pub  4096R/BCC40987  created: 2024-02-09  expires: 2026-02-08  usage: SCEA
                     trust: unknown       validity: unknown
[ unknown] (1). Open Job Description 

Please decide how far you trust this user to correctly verify other users' keys
(by looking at passports, checking fingerprints from different sources, etc.)

  1 = I don't know or won't say
  2 = I do NOT trust
  3 = I trust marginally
  4 = I trust fully
  5 = I trust ultimately
  m = back to the main menu

Your decision? 5
Do you really want to set this key to ultimate trust? (y/N) y

pub  4096R/BCC40987  created: 2024-02-09  expires: 2026-02-08  usage: SCEA
                     trust: ultimate      validity: unknown
[ unknown] (1). Open Job Description 
Please note that the shown key validity is not necessarily correct
unless you restart the program.

gpg&gt; quit

Verify the signature of the Open Job Description release via gpg --verify. The command for verifying the example files from step 1 would be:
```
gpg --verify ./openjd_cli-1.2.3-py3-none-any.whl.sig ./openjd_cli-1.2.3-py3-none-any.whl
```

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

FAQs

What is openjd-cli?

Provides a command-line interface for working with Open Job Description templates. Visit Snyk Advisor to see a full health score report for openjd-cli, including popularity, security, maintenance & community analysis.

Is openjd-cli popular?

The python package openjd-cli receives a total of 295 weekly downloads. As such, openjd-cli popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is openjd-cli well maintained?

We found that openjd-cli demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is openjd-cli safe to use?

The python package openjd-cli was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 25 November-2024, at 15:50 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Open Job Description - CLI

Compatibility

Versioning

Contributing

Commands

Getting Help

check

Arguments

Example

summary

Arguments

Example

run

Arguments

Example

schema

Arguments

Example

Downloading

Verifying GitHub Releases

Security

License

FAQs

What is openjd-cli?

Is openjd-cli popular?

Is openjd-cli well maintained?

Is openjd-cli safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`check`

`summary`

`run`

`schema`