Skip to content

JuryA/landscape_api_py3

Repository files navigation

Landscape API (Python 3)

image

image

image

Documentation Status

FOSSA Status

Client for the Landscape API (Python 3)

Features

  • easy installation from PyPI (you can use pipenv, pip, pipex, Chocolatey, ...)
  • working on Windows (pipx create landscape-api.exe shim)
  • working with Python>=v3.5 (easily from landscape_api_py3.base import API)
  • for quick use can be installed with pipx install landscape_api_py3

Quick start

Check if you have installed Python v3.5 and above.

To install Landscape API (Python 3), run this command in your terminal:

On Linux:

$ pip install landscape-api-py3
$ python -m landscape-api --uri https://your-uri-to-ls-api/api --key <your API key> --secret <your API secret> --json get-computers --limit 1

On Windows:

C:\> pip install landscape-api-py3
C:\> python -m landscape-api --uri https://your-uri-to-ls-api/api --key <your API key> --secret <your API secret> --json get-computers --limit 1

or you can use pipx (virtual environment will be created automatically):

On Linux:

$ pip install --user pipx
$ pipx ensurepath
$ exec $SHELL # Restart your shell to reload PATH
$ pipx install landscape-api-py3
$ landscape-api --uri https://your-uri-to-ls-api/api --key <your API key> --secret <your API secret> --json get-computers --limit 1

On Windows:

C:\> pip install --user pipx
C:\> pipx ensurepath
C:\> REM Restart console window to reload PATH
C:\> pipx install landscape-api-py3
C:\> landscape-api --uri https://your-uri-to-ls-api/api --key <your API key> --secret <your API secret> --json get-computers --limit 1

Known issues

  • none (issues with dependencies resolved in v0.3.0)

Credits

Based on package landscape-api from Canonical Ltd. This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

License

FOSSA Status