PyPI 官网下载 | PyArtifactory-1.9.0.tar.gz

# PyArtifactory [](https://github.com/anancarv/python-artifactory/actions) [](https://badge.fury.io/py/pyartifactory) [](https://app.codacy.com/app/Ananias/python-artifactory?utm_source=github.com&utm_medium=referral&utm_content=anancarv/python-artifactory&utm_campaign=Badge_Grade_Dashboard) [](https://www.codacy.com/manual/Ananias/python-artifactory?utm_source=github.com&utm_medium=referral&utm_content=anancarv/python-artifactory&utm_campaign=Badge_Coverage)  `pyartifactory` is a Python library to access the [Artifactory REST API](https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API). This library enables you to manage Artifactory resources such as users, groups, permissions, repositories, artifacts and access tokens in your applications. Based on Python 3.6+ type hints. <!-- toc --> - [Requirements](#requirements) - [Install](#install) - [Usage](#usage) * [Authentication](#authentication) * [SSL Cert Verification Options](#ssl-cert-verification-options) * [Admin objects](#admin-objects) + [User](#user) + [Group](#group) + [Security](#security) + [Repository](#repository) + [Permission](#permission) - [Artifactory 6.6.0 or higher](#artifactory-660-or-higher) - [Artifactory lower than 6.6.0](#artifactory-lower-than-660) * [Artifacts](#artifacts) + [Get the information about a file or folder](#get-the-information-about-a-file-or-folder) + [Deploy an artifact](#deploy-an-artifact) + [Download an artifact](#download-an-artifact) + [Retrieve artifact properties](#retrieve-artifact-properties) + [Retrieve artifact stats](#retrieve-artifact-stats) + [Copy artifact to a new location](#copy-artifact-to-a-new-location) + [Move artifact to a new location](#move-artifact-to-a-new-location) + [Delete an artifact](#delete-an-artifact) * [Contributing](#contributing) <!-- tocstop --> ## Requirements * Python 3.6+ ## Install ```python pip install pyartifactory ``` ## Usage ### Authentication Since Artifactory 6.6.0 there is version 2 of the REST API for permission management, in case you have that version or higher, you need to pass api_version=2 to the constructor when you instantiate the class. ```python from pyartifactory import Artifactory art = Artifactory(url="ARTIFACTORY_URL", auth=('USERNAME','PASSWORD_OR_API_KEY'), api_version=1) ``` ### SSL Cert Verification Options Specify a local cert to use as client side certificate ```python from pyartifactory import Artifactory art = Artifactory(url="ARTIFACTORY_URL", auth=('USERNAME','PASSORD_OR_API_KEY'), cert="/path_to_file/server.pem",api_version=1) ``` Disable host cert verification ```python from pyartifactory import Artifactory art = Artifactory(url="ARTIFACTORY_URL", auth=('USERNAME','PASSORD_OR_API_KEY'), verify=False, api_version=1) ``` ### Admin objects #### User First, you need to create a new Artifactory object. ```python from pyartifactory import Artifactory art = Artifactory(url="ARTIFACTORY_URL", auth=('USERNAME','PASSORD_OR_API_KEY')) ``` Get the list of users: ```python users = art.users.list() ``` Get a single user: ```python user = art.users.get("test_user") ``` Create a user: ```python from pyartifactory.models import NewUser # Create User user = NewUser(name="test_user", password="test_password", email="user@user.com") new_user = art.users.create(user) # Update user user.email = "test@test.com" updated_user = art.users.update(user) ``` Update a user: ```python from pyartifactory.models import User user = art.users.get("test_user") # Update user user.email = "test@test.com" updated_user = art.users.update(user) ``` Delete a user: ```python art.users.delete("test_user") ``` Unlock a user: ```python art.users.unlock("test_user") ``` #### Group Get the list of groups: ```python groups = art.groups.list() ``` Get a single group: ```python group = art.groups.get("group_name") ``` Create/Update a group: ```python from pyartifactory.models import Group # Create a Group group = Group(name="test_group", description="test_group") new_group = art.groups.create(group) # Update a Group group.description = "test_group_2" updated_group = art.groups.update(group) ``` Delete a group: ```python art.groups.delete("test_group") ``` #### Security A set of methods for performing operations on apiKeys, passwords ... ```python >>> art.security. art.security.create_api_key( art.security.get_encrypted_password( art.security.revoke_api_key( art.security.get_api_key( art.security.regenerate_api_key( art.security.revoke_user_api_key( ``` Create an access token (for a transient user): ```python token = art.security.create_access_token(user_name='transient_artifactory_user', groups=['g1', 'g2'], refreshable=True) ``` Create an access token for an existing user (groups are implied from the existing user): ```python token = art.security.create_access_token(user_name='existing_artifactory_user', refreshable=True) ``` Revoke an existing revocable token: ```python art.security.revoke_access_token(token.access_token) ``` #### Repository Get the list of repositories: ```python repositories = art.repositories.list() ``` Get a single repository ```python repo = art.repositories.get_repo("repo_name") # According to the repo type, you'll have either a local, virtual or remote repository returned ``` Create/Update a repository: ```python from pyartifactory.models import LocalRepository, VirtualRepository, RemoteRepository # Create local repo local_repo = LocalRepository(key="test_local_repo") new_local_repo = art.repositories.create_repo(local_repo) # Create virtual repo virtual_repo = VirtualRepository(key="test_virtual_repo") new_virtual_repo = art.repositories.create_repo(virtual_repo) # Create remote repo remote_repo = RemoteRepository(key="test_remote_repo") new_remote_repo = art.repositories.create_repo(remote_repo) # Update a repository local_repo = art.repositories.get_repo("test_local_repo") local_repo.description = "test_local_repo" updated_local_repo = art.repositories.update_repo(local_repo) ``` Delete a repository: ```python art.repositories.delete("test_local_repo") ``` #### Permission Get the list of permissions: ```python permissions = art.permissions.list() ``` Get a single permission: ```python users = art.permissions.get("test_permission") ``` Create/Update a permission: ##### Artifactory 6.6.0 or higher ```python from pyartifactory.models import PermissionV2 from pyartifactory.models.permission import PermissionEnumV2, PrincipalsPermissionV2, RepoV2 # Create a permission permission = PermissionV2( name="test_permission", repo=RepoV2( repositories=["test_repository"], actions=PrincipalsPermissionV2( users={ "test_user": [ PermissionEnumV2.read, PermissionEnumV2.annotate, PermissionEnumV2.write, PermissionEnumV2.delete, ] }, groups={ "developers": [ PermissionEnumV2.read, PermissionEnumV2.annotate, PermissionEnumV2.write, PermissionEnumV2.delete, ], }, ), includePatterns=["**"], excludePatterns=[], ) ) perm = art.permissions.create(permission) # Update permission permission.repo.repos