audfactory - npm Package Compare versions

Comparing version 1.0.8 to 1.0.9

docs/_templates/autosummary/base.rst

+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ fullname }}

docs/_templates/autosummary/class.rst

+{{ objname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+{% block methods %}
+{%- for item in (all_methods + attributes)|sort %}
+    {%- if not item.startswith('_') or item in ['__call__', '__getitem__'] %}
+        {%- if item in all_methods %}
+{{ (item + '()') | escape | underline(line='-') }}
+.. automethod:: {{ name }}.{{ item }}
+        {%- elif item in attributes %}
+{{ item | escape | underline(line='-') }}
+.. autoattribute:: {{ name }}.{{ item }}
+        {%- endif %}
+    {% endif %}
+{%- endfor %}
+{% endblock %}

docs/_templates/autosummary/function.rst

+{{ (name + '()') | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ fullname }}

docs/api-src/audfactory.rst

+audfactory
+==========
+
+.. automodule:: audfactory
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+
+    Lookup
+    authentification
+    checksum
+    deploy
+    download
+    group_id_to_path
+    path
+    path_to_group_id
+    rest_api_get
+    url
+    versions

.github/workflows/publish.yml

@@ -12,3 +12,3 @@ name: Publish
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
@@ -18,3 +18,3 @@ fetch-depth: 2
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
@@ -69,3 +69,3 @@ python-version: '3.8'
       id: create_release
-      uses: actions/create-release@v1
+      uses: softprops/action-gh-release@v1
       env:
@@ -75,3 +75,3 @@ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         tag_name: ${{ github.ref }}
-        release_name: Release ${{ github.ref }}
+        release_name: Release ${{ github.ref_name }}
         body: ${{ steps.changelog.outputs.body }}

.github/workflows/test.yml

@@ -5,5 +5,5 @@ name: Test
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
@@ -17,14 +17,16 @@ jobs:
         os: [ ubuntu-20.04, windows-latest, macOS-latest ]
-        python-version: [3.8]
+        python-version: [ '3.8' ]
         include:
           - os: ubuntu-latest
-            python-version: 3.7
+            python-version: '3.7'
           - os: ubuntu-latest
-            python-version: 3.9
+            python-version: '3.9'
+          - os: ubuntu-latest
+            python-version: '3.10'
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
@@ -49,3 +51,3 @@ python-version: ${{ matrix.python-version }}
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v3
       with:
@@ -52,0 +54,0 @@ token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -10,1 +10,2 @@ __pycache__
 coverage.xml
+docs/api/

audfactory.egg-info/PKG-INFO

 Metadata-Version: 1.2
 Name: audfactory
-Version: 1.0.8
+Version: 1.0.9
 Summary: Communicate with Artifactory
@@ -56,2 +56,10 @@ Home-page: https://github.com/audeering/audfactory/
         
+        Version 1.0.9 (2022-12-23)
+        --------------------------
+        
+        * Added: support for Python 3.10
+        * Changed: split API documentation into sub-pages
+          for each function
+        
+        
         Version 1.0.8 (2022-01-03)
@@ -371,2 +379,3 @@ --------------------------
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Scientific/Engineering

audfactory.egg-info/SOURCES.txt

@@ -20,3 +20,2 @@ .gitignore
 audfactory/core/lookup.py
-docs/api-audfactory.rst
 docs/changelog.rst
@@ -30,2 +29,6 @@ docs/conf.py
 docs/usage.rst
+docs/_templates/autosummary/base.rst
+docs/_templates/autosummary/class.rst
+docs/_templates/autosummary/function.rst
+docs/api-src/audfactory.rst
 tests/conftest.py
@@ -32,0 +35,0 @@ tests/requirements.txt

audfactory/core/api.py

@@ -77,3 +77,3 @@ import errno
 
-    Example:
+    Examples:
         >>> checksum(
@@ -203,3 +203,3 @@ ...     'https://audeering.jfrog.io/artifactory/'
 
-    Example:
+    Examples:
         >>> file = download(
@@ -265,3 +265,3 @@ ...     (
 
-    Example:
+    Examples:
         >>> group_id_to_path('com.audeering.data.emodb')
@@ -297,3 +297,3 @@ 'com/audeering/data/emodb'
 
-    Example:
+    Examples:
         >>> artifactory_path = path(
@@ -325,3 +325,3 @@ ...     'https://audeering.jfrog.io/artifactory/data-public/emodb/'
 
-    Example:
+    Examples:
         >>> path_to_group_id('com/audeering/data/emodb')
@@ -348,3 +348,3 @@ 'com.audeering.data.emodb'
 
-    Example:
+    Examples:
         >>> r = rest_api_get(
@@ -384,3 +384,3 @@ ...     'https://audeering.jfrog.io/artifactory/'
 
-    Example:
+    Examples:
         >>> url(
@@ -387,0 +387,0 @@ ...     'https://audeering.jfrog.io/artifactory',

audfactory/core/lookup.py

@@ -61,3 +61,3 @@ import csv
 
-    Example:
+    Examples:
         >>> lookup = Lookup(
@@ -470,3 +470,3 @@ ...     'https://artifactory.audeering.com/artifactory',
 
-        Example:
+        Examples:
             >>> Lookup.exists(
@@ -506,3 +506,3 @@ ...     'https://artifactory.audeering.com/artifactory',
 
-        Example:
+        Examples:
             >>> Lookup.latest_version(
@@ -548,3 +548,3 @@ ...     'https://artifactory.audeering.com/artifactory',
 
-        Example:
+        Examples:
             >>> Lookup.generate_uid(
@@ -592,3 +592,3 @@ ...     params={0: None},
 
-        Example:
+        Examples:
             >>> Lookup.versions(
@@ -595,0 +595,0 @@ ...     'https://artifactory.audeering.com/artifactory',

CHANGELOG.rst

@@ -10,2 +10,10 @@ Changelog
 
+Version 1.0.9 (2022-12-23)
+--------------------------
+
+* Added: support for Python 3.10
+* Changed: split API documentation into sub-pages
+  for each function
+
+
 Version 1.0.8 (2022-01-03)
@@ -12,0 +20,0 @@ --------------------------

docs/conf.py

@@ -0,4 +1,5 @@
+import configparser
 from datetime import date
 import os
-from subprocess import check_output
+import shutil
 import sys
@@ -9,13 +10,12 @@
 
+config = configparser.ConfigParser()
+config.read(os.path.join('..', 'setup.cfg'))
+
+
 # Project -----------------------------------------------------------------
-project = 'audfactory'
+author = config['metadata']['author']
 copyright = f'2019-{date.today().year} audEERING GmbH'
-author = 'Hagen Wierstorf'
-# The x.y.z version read from tags
-try:
-    version = check_output(['git', 'describe', '--tags', '--always'])
-    version = version.decode().strip()
-except Exception:
-    version = '<unknown>'
-title = '{} Documentation'.format(project)
+project = config['metadata']['name']
+version = audeer.git_repo_version()
+title = 'Documentation'
 
@@ -27,3 +27,10 @@
 source_suffix = '.rst'
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = [
+    'build',
+    'tests',
+    'Thumbs.db',
+    '.DS_Store',
+    'api-src',
+]
+templates_path = ['_templates']
 pygments_style = None
@@ -33,2 +40,3 @@ extensions = [
     'sphinx.ext.napoleon',  # support for Google-style docstrings
+    'sphinx.ext.autosummary',
     'sphinx_autodoc_typehints',
@@ -42,4 +50,4 @@ 'sphinx.ext.viewcode',
     'audeer': ('https://audeering.github.io/audeer/', None),
+    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
     'python': ('https://docs.python.org/3/', None),
-    'pandas': ('https://pandas-docs.github.io/pandas-docs-travis/', None),
 }
@@ -52,3 +60,7 @@ # Disable Gitlab as we need to sign in
 
+# Disable auto-generation of TOC entries in the API
+# https://github.com/sphinx-doc/sphinx/issues/6316
+toc_object_entries = False
 
+
 # HTML --------------------------------------------------------------------
@@ -65,1 +77,13 @@ html_theme = 'sphinx_audeering_theme'
 html_title = title
+
+
+# Copy API (sub-)module RST files to docs/api/ folder ---------------------
+audeer.rmdir('api')
+audeer.mkdir('api')
+api_src_files = audeer.list_file_names('api-src')
+api_dst_files = [
+    audeer.path('api', os.path.basename(src_file))
+    for src_file in api_src_files
+]
+for src_file, dst_file in zip(api_src_files, api_dst_files):
+    shutil.copyfile(src_file, dst_file)

docs/index.rst

@@ -20,3 +20,3 @@ .. audfactory documentation master file
 
-    api-audfactory
+    api/audfactory
     genindex
@@ -23,0 +23,0 @@

PKG-INFO

 Metadata-Version: 1.2
 Name: audfactory
-Version: 1.0.8
+Version: 1.0.9
 Summary: Communicate with Artifactory
@@ -56,2 +56,10 @@ Home-page: https://github.com/audeering/audfactory/
         
+        Version 1.0.9 (2022-12-23)
+        --------------------------
+        
+        * Added: support for Python 3.10
+        * Changed: split API documentation into sub-pages
+          for each function
+        
+        
         Version 1.0.8 (2022-01-03)
@@ -371,2 +379,3 @@ --------------------------
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Scientific/Engineering

setup.cfg

@@ -25,2 +25,3 @@ [metadata]
 	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
 	Topic :: Scientific/Engineering
@@ -27,0 +28,0 @@

tests/requirements.txt

@@ -0,1 +1,3 @@
+# To avoid https://github.com/tholo/pytest-flake8/issues/87
+flake8 <5.0.0
 audeer>=1.12.0
@@ -2,0 +4,0 @@ pandas

docs/api-audfactory.rst

-audfactory
-==========
-
-.. automodule:: audfactory
-
-authentification
-----------------
-
-.. autofunction:: authentification
-
-checksum
---------
-
-.. autofunction:: checksum
-
-deploy
----------------
-
-.. autofunction:: deploy
-
-download
---------
-
-.. autofunction:: download
-
-group_id_to_path
-----------------
-
-.. autofunction:: group_id_to_path
-
-Lookup
-------
-
-.. autoclass:: Lookup
-    :members:
-    :special-members: __getitem__
-
-path
-----
-
-.. autofunction:: path
-
-path_to_group_id
-----------------
-
-.. autofunction:: path_to_group_id
-
-rest_api_get
-------------
-
-.. autofunction:: rest_api_get
-
-url
----
-
-.. autofunction:: url
-
-versions
---------
-
-.. autofunction:: versions

Alert delta unavailable

Currently unable to show alert delta for PyPI packages.

Improved metrics

Total package byte prevSize

108421

1.83%

Number of package files

36

9.09%

Lines of code

1856

1.03%