/rtpy

Python wrapper for the JFrog Artifactory REST API

Primary LanguagePythonApache License 2.0Apache-2.0

rtpy

image image Code style: black Documentation Status image

Python wrapper for the JFrog Artifactory REST API

Documentation

https://rtpy.rtfd.io


Installation

$ pip install rtpy

Usage

import rtpy

# instantiate a rtpy.Rtpy object
settings = {}
settings["af_url"] = "http://..."
settings["api_key"] = "123QWA..."
# settings["username"] = "my_username"
# settings["password"] = "my_password"

af = rtpy.Rtpy(settings)

# use a method
r = af.system_and_configuration.system_health_ping()
print(r)
# OK

Running the tests

Requirements :

  • Dependencies : see [tool.poetry.dependencies] and [tool.poetry.dev-dependencies] in pyproject.toml
  • Artifactory instance (with a valid license) running

NEVER run the tests on a production instance!

Launch

  • Set the following environment variables:
    • AF_TEST_URL
    • AF_TEST_USERNAME
    • AF_TEST_PASSWORD

The user must have admin privileges (it's API key will be revoked during the tests)

  • Clone the repository and launch the tests using the command :
$ python -m pytest -v