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/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/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
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.16.tar.gz
(14.4 kB
view hashes)
Built Distributions
Close
Hashes for dohq_artifactory-0.2.16-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4ea28e1030dd1a19577265f257e38a4d0257659a6ccc14d7b8cb9f001d227271 |
|
| MD5 | c64854f4afe85ce752102244c1d0dcc2 |
|
| BLAKE2b-256 | e428443d10b76a2f1ed9c43618a807e6eb54a3d89a9441668c8bd042c8505230 |
Close
Hashes for dohq_artifactory-0.2.16-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fab3eaff4ace69cf36d6719ccbf488d4cd62b75d67ea69ac9ad50d4e755dea43 |
|
| MD5 | 13a25a9a65ebc20f2f732f40f60db3a8 |
|
| BLAKE2b-256 | 169447bfe4214d549af438bd0825e78dd4d143d6bf1f811d080f15f8e3865065 |
