Merge branch 'main' into corpusbuilder

elpaco-escience · Apr 7, 2023 · e430680 · e430680
2 parents d843572 + 01e501f
commit e430680
Show file tree

Hide file tree

Showing 23 changed files with 195 additions and 295 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -4,7 +4,7 @@ current_version = 0.1.0
 [comment]
 comment = The contents of this file cannot be merged with that of setup.cfg until https://github.com/c4urself/bump2version/issues/185 is resolved
 
-[bumpversion:file:scikit-talk/__init__.py]
+[bumpversion:file:sktalk/__init__.py]
 search = __version__ = "{current_version}"
 replace = __version__ = "{new_version}"
 

diff --git a/.githooks/pre-commit b/.githooks/pre-commit
@@ -1,5 +1,8 @@
 #!/bin/sh
 
+### To enable this githook, run:
+### git config --local core.hooksPath .githooks
+
 echo "Script $0 triggered ..."
 
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
@@ -17,13 +20,13 @@ fi
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 echo "Starting isort analysis using configuration from setup.cfg..."
 
-# recursively run isort on scikit-talk/ directory, don't try to automatically fix anything
-isort --recursive --check-only scikit-talk
+# recursively run isort on sktalk/ directory, don't try to automatically fix anything
+isort --check-only sktalk
 
 if [ $? != "0" ]; then
     echo "Commit aborted."
     echo "  Run 'isort --check-only --diff scikit-talk' to see what's wrong."
-    echo "  Run 'isort scikit-talk' to let isort fix problems automatically."
+    echo "  Run 'isort sktalk' to let isort fix problems automatically."
     exit 1
 fi
 

diff --git a/.github/next_steps/01_sonarcloud_integration.md b/.github/next_steps/01_sonarcloud_integration.md
diff --git a/.github/next_steps/02_citation.md b/.github/next_steps/02_citation.md
diff --git a/.github/next_steps/03_readthedocs.md b/.github/next_steps/03_readthedocs.md
diff --git a/.github/next_steps/04_zenodo_integration.md b/.github/next_steps/04_zenodo_integration.md
diff --git a/.github/next_steps/05_linting.md b/.github/next_steps/05_linting.md
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -16,8 +16,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        os: ['ubuntu-latest', 'windows-latest']
+        python-version: ['3.7', '3.10']
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
@@ -61,4 +61,4 @@ jobs:
       - name: Check style against standards using prospector
         run: prospector
       - name: Check import order
-        run: isort --check-only scikit-talk --diff
+        run: isort --check-only sktalk --diff
diff --git a/.github/workflows/cffconvert.yml b/.github/workflows/cffconvert.yml
@@ -2,20 +2,18 @@ name: cffconvert
 
 on:
   push:
-    branches:
-    - main
-  pull_request:
-    branches:
-    - main
+    paths:
+      - CITATION.cff
 
 jobs:
-
-  verify:
-    name: "cffconvert"
+  validate:
+    name: "validate"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-        name: Check out a copy of the repository
+      - name: Check out a copy of the repository
+        uses: actions/checkout@v2
 
-      - uses: citation-file-format/cffconvert-github-action@main
-        name: Check whether the citation metadata from CITATION.cff is equivalent to that in .zenodo.json
+      - name: Check whether the citation metadata from CITATION.cff is valid
+        uses: citation-file-format/cffconvert-github-action@2.0.0
+        with:
+          args: "--validate"
diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml
diff --git a/.github/workflows/next_steps.yml b/.github/workflows/next_steps.yml
diff --git a/CITATION.cff b/CITATION.cff
@@ -6,13 +6,29 @@ authors:
   -
     family-names: Vreede
     given-names: Barbara
-    orcid: "https://orcid.org/0000-0000-0000-0000"
-date-released: 20??-MM-DD
+    orcid: "https://orcid.org/0000-0002-5023-4601"
+  -
+    family-names: Liesenfeld
+    given-names: Andreas
+    orcid: "https://orcid.org/0000-0001-6076-4406"
+  -
+    family-names: Gabor
+    given-names: Parti
+  -
+    family-names: Viviani
+    given-names: Eva
+    orcid: "https://orcid.org/0000-0002-1330-0585"
+  -
+    family-names: Dingemanse
+    given-names: Mark
+    orcid: "https://orcid.org/0000-0002-3290-5723"
+date-released: 2023-MM-DD
 doi: <insert your DOI here>
 version: "0.1.0"
-repository-code: "git@github.com:elpaco-escience/scikit-talk"
+repository-code: "https://github.com/elpaco-escience/scikit-talk"
 keywords:
-  - conversation
-  - keyword2
+    - conversation
+    - language corpora
+    - turn-taking
 message: "If you use this software, please cite it using these metadata."
 license: Apache-2.0
diff --git a/README.md b/README.md
@@ -15,10 +15,12 @@
 | Coverage                           | [![workflow scc badge](https://sonarcloud.io/api/project_badges/measure?project=elpaco-escience_scikit-talk&metric=coverage)](https://sonarcloud.io/dashboard?id=elpaco-escience_scikit-talk) |
 | Documentation                      | [![Documentation Status](https://readthedocs.org/projects/scikit-talk/badge/?version=latest)](https://scikit-talk.readthedocs.io/en/latest/?badge=latest) |
 | **GitHub Actions**                 | &nbsp; |
-| Build                              | [![build](git@github.com:elpaco-escience/scikit-talk/actions/workflows/build.yml/badge.svg)](git@github.com:elpaco-escience/scikit-talk/actions/workflows/build.yml) |
-| Citation data consistency               | [![cffconvert](git@github.com:elpaco-escience/scikit-talk/actions/workflows/cffconvert.yml/badge.svg)](git@github.com:elpaco-escience/scikit-talk/actions/workflows/cffconvert.yml) |
-| SonarCloud                         | [![sonarcloud](git@github.com:elpaco-escience/scikit-talk/actions/workflows/sonarcloud.yml/badge.svg)](git@github.com:elpaco-escience/scikit-talk/actions/workflows/sonarcloud.yml) |
-| MarkDown link checker              | [![markdown-link-check](git@github.com:elpaco-escience/scikit-talk/actions/workflows/markdown-link-check.yml/badge.svg)](git@github.com:elpaco-escience/scikit-talk/actions/workflows/markdown-link-check.yml) |
+| Build                              | [![build](https://github.com/elpaco-escience/scikit-talk/actions/workflows/build.yml/badge.svg)](https://github.com/elpaco-escience/scikit-talk/actions/workflows/build.yml) |
+| SonarCloud                         | [![sonarcloud](https://github.com/elpaco-escience/scikit-talk/actions/workflows/sonarcloud.yml/badge.svg)](https://github.com/elpaco-escience/scikit-talk/actions/workflows/sonarcloud.yml) |
+| Citation data consistency               | [![cffconvert](https://github.com/elpaco-escience/scikit-talk/actions/workflows/cffconvert.yml/badge.svg)](https://github.com/elpaco-escience/scikit-talk/actions/workflows/cffconvert.yml) |
+
+
+
 
 ## How to use scikit-talk
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -61,7 +61,7 @@
 
 # -- Use autoapi.extension to run sphinx-apidoc -------
 
-autoapi_dirs = ['../scikit-talk']
+autoapi_dirs = ['../sktalk']
 
 # -- Options for HTML output ----------------------------------------------
 
@@ -78,11 +78,12 @@
 
 # -- Options for Intersphinx
 
-intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
-                       # Commonly used libraries, uncomment when used in package
-                       # 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
-                       # 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
-                       # 'scikit-learn': ('https://scikit-learn.org/stable/', None),
-                       # 'matplotlib': ('https://matplotlib.org/stable/', None),
-                       # 'pandas': ('http://pandas.pydata.org/docs/', None),
-                       }
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    # Commonly used libraries, uncomment when used in package
+    # 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
+    # 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
+    # 'scikit-learn': ('https://scikit-learn.org/stable/', None),
+    # 'matplotlib': ('https://matplotlib.org/stable/', None),
+    # 'pandas': ('http://pandas.pydata.org/docs/', None),
+    }