A Python to Artifactory interface
Project description
Python interface library for Jfrog Artifactory
==============================================
`|dohq-artifactory build
Status| <https://travis-ci.org/devopshq/artifactory>`_
`|dohq-artifactory code
quality| <https://www.codacy.com/app/tim55667757/dohq-artifactory/dashboard>`_
`|dohq-artifactory on
PyPI| <https://pypi.python.org/pypi/dohq-artifactory>`_
`|dohq-artifactory
license| <https://github.com/devopshq/artifactory/blob/master/LICENSE>`_
This module is intended to serve as a logical descendant of
`pathlib <https://docs.python.org/3/library/pathlib.html>`_, a Python 3
module for object-oriented path manipulations. As such, it implements
everything as closely as possible to the origin with few exceptions,
such as stat().
Usage Examples
==============
Walking Directory Tree
----------------------
Getting directory listing:
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://repo.jfrog.org/artifactory/gradle-ivy-local")
for p in path:
print(p)
Find all .gz files in current dir, recursively:
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://repo.jfrog.org/artifactory/distributions/org/")
for p in path.glob("**/*.gz"):
print(p)
Downloading Artifacts
---------------------
Download artifact to a local filesystem:
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://repo.jfrog.org/artifactory/distributions/org/apache/tomcat/apache-tomcat-7.0.11.tar.gz")
with path.open() as fd:
with open("tomcat.tar.gz", "wb") as out:
out.write(fd.read())
Uploading Artifacts
-------------------
Deploy a regular file ``myapp-1.0.tar.gz``
\`\`\`python from artifactory import ArtifactoryPath path =
ArtifactoryPath(
"http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0")
path.mkdir()
path.deploy\_file('./myapp-1.0.tar.gz')
``Deploy a debian package``myapp-1.0.deb\`\`\`
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://my-artifactory/artifactory/ubuntu-local/pool")
path.deploy_deb('./myapp-1.0.deb',
distribution='trusty',
component='main',
architecture='amd64')
Authentication
--------------
To provide username and password to access restricted resources, you can
pass ``auth`` parameter to ArtifactoryPath:
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://my-artifactory/artifactory/myrepo/restricted-path",
auth=('admin', 'ilikerandompasswords'))
path.touch()
SSL Cert Verification Options
-----------------------------
See `Requests - SSL
verification <http://docs.python-requests.org/en/latest/user/advanced/#ssl-cert-verification>`_
for more details.
``python from artifactory import ArtifactoryPath path = ArtifactoryPath( "http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0")``
... is the same as
``python from artifactory import ArtifactoryPath path = ArtifactoryPath( "http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0", verify=True)``
Specify a local cert to use as client side certificate
``python from artifactory import ArtifactoryPath path = ArtifactoryPath( "http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0", cert="/path_to_file/server.pem")``
Disable host cert verification
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0",
verify=False)
**Note:** If host cert verification is disabled urllib3 will throw a
`InsecureRequestWarning <https://urllib3.readthedocs.org/en/latest/security.html#insecurerequestwarning>`_.
To disable these warning, one needs to call urllib3.disable\_warnings().
``python import requests.packages.urllib3 as urllib3 urllib3.disable_warnings()``
Global Configuration File
-------------------------
Artifactory Python module also has a way to specify all
connection-related settings in a central file,
``~/.artifactory_python.cfg`` that is read upon the creation of first
``ArtifactoryPath`` object and is stored globally. For instance, you can
specify per-instance settings of authentication tokens, so that you
won't need to explicitly pass ``auth`` parameter to ``ArtifactoryPath``.
Example:
::
[http://artifactory-instance.com/artifactory]
username = deployer
password = ilikerandompasswords
verify = false
[another-artifactory-instance.com/artifactory]
username = foo
password = @dmin
cert = ~/mycert
Whether or not you specify ``http://`` or ``https://`` prefix is not
essential. The module will first try to locate the best match and then
try to match URLs without prefixes. So if in the config you specify
``https://my-instance.local`` and call ``ArtifactoryPath`` with
``http://my-instance.local``, it will still do the right thing.
.. |dohq-artifactory build
Status| image:: https://travis-ci.org/devopshq/artifactory.svg?branch=master
.. |dohq-artifactory code
quality| image:: https://api.codacy.com/project/badge/Grade/ce32469db9d948bcb56d50532e0c0005
.. |dohq-artifactory on
PyPI| image:: https://img.shields.io/pypi/v/dohq-artifactory.svg
.. |dohq-artifactory
license| image:: https://img.shields.io/pypi/l/dohq-artifactory.svg
==============================================
`|dohq-artifactory build
Status| <https://travis-ci.org/devopshq/artifactory>`_
`|dohq-artifactory code
quality| <https://www.codacy.com/app/tim55667757/dohq-artifactory/dashboard>`_
`|dohq-artifactory on
PyPI| <https://pypi.python.org/pypi/dohq-artifactory>`_
`|dohq-artifactory
license| <https://github.com/devopshq/artifactory/blob/master/LICENSE>`_
This module is intended to serve as a logical descendant of
`pathlib <https://docs.python.org/3/library/pathlib.html>`_, a Python 3
module for object-oriented path manipulations. As such, it implements
everything as closely as possible to the origin with few exceptions,
such as stat().
Usage Examples
==============
Walking Directory Tree
----------------------
Getting directory listing:
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://repo.jfrog.org/artifactory/gradle-ivy-local")
for p in path:
print(p)
Find all .gz files in current dir, recursively:
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://repo.jfrog.org/artifactory/distributions/org/")
for p in path.glob("**/*.gz"):
print(p)
Downloading Artifacts
---------------------
Download artifact to a local filesystem:
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://repo.jfrog.org/artifactory/distributions/org/apache/tomcat/apache-tomcat-7.0.11.tar.gz")
with path.open() as fd:
with open("tomcat.tar.gz", "wb") as out:
out.write(fd.read())
Uploading Artifacts
-------------------
Deploy a regular file ``myapp-1.0.tar.gz``
\`\`\`python from artifactory import ArtifactoryPath path =
ArtifactoryPath(
"http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0")
path.mkdir()
path.deploy\_file('./myapp-1.0.tar.gz')
``Deploy a debian package``myapp-1.0.deb\`\`\`
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://my-artifactory/artifactory/ubuntu-local/pool")
path.deploy_deb('./myapp-1.0.deb',
distribution='trusty',
component='main',
architecture='amd64')
Authentication
--------------
To provide username and password to access restricted resources, you can
pass ``auth`` parameter to ArtifactoryPath:
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://my-artifactory/artifactory/myrepo/restricted-path",
auth=('admin', 'ilikerandompasswords'))
path.touch()
SSL Cert Verification Options
-----------------------------
See `Requests - SSL
verification <http://docs.python-requests.org/en/latest/user/advanced/#ssl-cert-verification>`_
for more details.
``python from artifactory import ArtifactoryPath path = ArtifactoryPath( "http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0")``
... is the same as
``python from artifactory import ArtifactoryPath path = ArtifactoryPath( "http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0", verify=True)``
Specify a local cert to use as client side certificate
``python from artifactory import ArtifactoryPath path = ArtifactoryPath( "http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0", cert="/path_to_file/server.pem")``
Disable host cert verification
::
from artifactory import ArtifactoryPath
path = ArtifactoryPath(
"http://my-artifactory/artifactory/libs-snapshot-local/myapp/1.0",
verify=False)
**Note:** If host cert verification is disabled urllib3 will throw a
`InsecureRequestWarning <https://urllib3.readthedocs.org/en/latest/security.html#insecurerequestwarning>`_.
To disable these warning, one needs to call urllib3.disable\_warnings().
``python import requests.packages.urllib3 as urllib3 urllib3.disable_warnings()``
Global Configuration File
-------------------------
Artifactory Python module also has a way to specify all
connection-related settings in a central file,
``~/.artifactory_python.cfg`` that is read upon the creation of first
``ArtifactoryPath`` object and is stored globally. For instance, you can
specify per-instance settings of authentication tokens, so that you
won't need to explicitly pass ``auth`` parameter to ``ArtifactoryPath``.
Example:
::
[http://artifactory-instance.com/artifactory]
username = deployer
password = ilikerandompasswords
verify = false
[another-artifactory-instance.com/artifactory]
username = foo
password = @dmin
cert = ~/mycert
Whether or not you specify ``http://`` or ``https://`` prefix is not
essential. The module will first try to locate the best match and then
try to match URLs without prefixes. So if in the config you specify
``https://my-instance.local`` and call ``ArtifactoryPath`` with
``http://my-instance.local``, it will still do the right thing.
.. |dohq-artifactory build
Status| image:: https://travis-ci.org/devopshq/artifactory.svg?branch=master
.. |dohq-artifactory code
quality| image:: https://api.codacy.com/project/badge/Grade/ce32469db9d948bcb56d50532e0c0005
.. |dohq-artifactory on
PyPI| image:: https://img.shields.io/pypi/v/dohq-artifactory.svg
.. |dohq-artifactory
license| image:: https://img.shields.io/pypi/l/dohq-artifactory.svg
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dohq-artifactory-0.2.15.tar.gz
(14.4 kB
view hashes)
Built Distributions
Close
Hashes for dohq_artifactory-0.2.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1bc65db36a7801bc647b0c4bf982facb8d77e6335deeaabb11824c64039a755 |
|
MD5 | a587b8792244763eb92e6a993489f881 |
|
BLAKE2b-256 | 66b9a88e533de74972e1ab68013b7cbc2051d6a25a458083240cf9c187c33622 |
Close
Hashes for dohq_artifactory-0.2.15-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | acb2919d6b87e58bafb7bbf4a56b9313fae80212b8434615b4fe561c7fa67ae0 |
|
MD5 | 7f34036be5615bd2aa9bb7846b4e8563 |
|
BLAKE2b-256 | 5688f1333bd322c98f3206d3ccf6f1330694e078f14aa0ac32ffb2ee7d1c492f |