audfactory - npm Package Compare versions

Comparing version 1.0.6 to 1.0.7

audfactory.egg-info/PKG-INFO

 Metadata-Version: 2.1
 Name: audfactory
-Version: 1.0.6
+Version: 1.0.7
 Summary: Communicate with Artifactory
@@ -71,2 +71,9 @@ Home-page: https://github.com/audeering/audfactory/
 
+Version 1.0.7 (2021-11-30)
+--------------------------
+
+* Changed: extend discussion of authentication
+  in usage section of docs
+
+
 Version 1.0.6 (2021-09-23)
@@ -73,0 +80,0 @@ --------------------------

CHANGELOG.rst

@@ -10,2 +10,9 @@ Changelog
 
+Version 1.0.7 (2021-11-30)
+--------------------------
+
+* Changed: extend discussion of authentication
+  in usage section of docs
+
+
 Version 1.0.6 (2021-09-23)
@@ -12,0 +19,0 @@ --------------------------

docs/usage.rst

@@ -8,17 +8,74 @@ Usage
 
-To access an Artifactory server,
-store your username and `API key`_ in :file:`~/.artifactory_python.cfg`
+Artifactory servers can allow anonymous access
+by logging in with a fixed pair
+of ``'anonymous'`` as username
+and ``''`` as password.
+This is the default behavior of :mod:`audfactory`.
 
+.. jupyter-execute::
+
+    import audfactory
+
+    audfactory.authentification('https://artifactory.domain.com/artifactory')
+
+To access an Artifactory server
+that requires logging in with a username and password,
+store your username and `API key`_
+in :file:`~/.artifactory_python.cfg`
+using separate sections for every server.
+Every section is marked
+by the server URL in square brackets
+without the ``https://`` or ``http://``
+at the beginning:
+
 .. code-block:: cfg
 
-    [artifactory.audeering.com/artifactory]
-    username = MY_USERNAME
-    password = MY_API_KEY
+    [artifactory1.domain.com/artifactory]
+    username = MY_USERNAME1
+    password = MY_API_KEY1
 
-and replace ``artifactory.audeering.com/artifactory``
-with your Artifactory server address.
-You can add several server entries.
+    [artifactory2.domain.com/artifactory]
+    username = MY_USERNAME2
+    password = MY_API_KEY2
 
-Alternatively, export the credentials as environment variables:
+.. Workaround to allow correct audfactory.authentification() output
+.. without having an actual config file
+.. jupyter-execute::
+    :hide-code:
+    :hide-output:
 
+    import os
+
+    os.environ['ARTIFACTORY_USERNAME'] = 'MY_USERNAME2'
+    os.environ['ARTIFACTORY_API_KEY'] = 'MY_API_KEY2'
+
+When authentication is requested for a configured server URL,
+the corresponding username and password pair
+is returned.
+
+.. jupyter-execute::
+
+    audfactory.authentification('https://artifactory2.domain.com/artifactory')
+
+Anonymous access is still used
+for every server
+not listed in the file.
+
+.. We need to delete the workaround environment variables
+.. to allow anonymous access again
+.. jupyter-execute::
+    :hide-code:
+    :hide-output:
+
+    del os.environ['ARTIFACTORY_USERNAME']
+    del os.environ['ARTIFACTORY_API_KEY']
+
+.. jupyter-execute::
+
+    audfactory.authentification('https://artifactory3.domain.com/artifactory')
+
+Alternatively,
+you can export
+the credentials as environment variables:
+
 .. code-block:: bash
@@ -25,0 +82,0 @@

PKG-INFO

 Metadata-Version: 2.1
 Name: audfactory
-Version: 1.0.6
+Version: 1.0.7
 Summary: Communicate with Artifactory
@@ -71,2 +71,9 @@ Home-page: https://github.com/audeering/audfactory/
 
+Version 1.0.7 (2021-11-30)
+--------------------------
+
+* Changed: extend discussion of authentication
+  in usage section of docs
+
+
 Version 1.0.6 (2021-09-23)
@@ -73,0 +80,0 @@ --------------------------

Alert delta unavailable

Currently unable to show alert delta for PyPI packages.

Improved metrics

Total package byte prevSize

100581

1.84%