Update some repo metadata (#11)

* add circleci badge

* make citation.cff release-independent

* skip ci on deploy

* clarify copyright for multiple authors

* update changelog

* add metadata

* address depr warn

Author: sappelhoff

.github/workflows/python_build-test-deploy.yml

@@ -116,7 +116,8 @@ jobs:
     - name: Deploy
       uses: JamesIves/github-pages-deploy-action@v4
       with:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        BRANCH: gh-pages # The branch the action should deploy to.
-        FOLDER: docs/_build/html # The folder the action should deploy.
-        CLEAN: true # Automatically remove deleted files from the deploy branch
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: gh-pages # The branch the action should deploy to.
+        folder: docs/_build/html # The folder the action should deploy.
+        clean: true # Automatically remove deleted files from the deploy branch
+        commit-message: "deploy to gh-pages [skip ci]"

CITATION.cff

@@ -2,21 +2,23 @@
 ---
 # Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/)
 cff-version: 1.2.0
+title: "eeg_positions -- compute and plot standard EEG electrode positions."
 message: "If you use this software, please cite it using the metadata in this file."
-abstract: "Compute and plot standard EEG electrode positions."
 authors:
 - given-names: "Stefan"
   family-names: "Appelhoff"
   orcid: "https://orcid.org/0000-0001-8002-0877"
 - given-names: "Clemens"
   family-names: "Brunner"
   orcid: "https://orcid.org/0000-0002-6030-2233"
-title: "eeg_positions"
-version: "2.0.0"
-doi: "10.5281/zenodo.4540097"
-date-released: "2021-02-13"
+type: software
 repository-code: "https://github.com/sappelhoff/eeg_positions"
 url: "https://stefanappelhoff.com/eeg_positions/"
+license: BSD-3-Clause
+identifiers:
+  - description: "Code archive on Zenodo"
+    type: doi
+    value: 10.5281/zenodo.4540097
 keywords:
 - "EEG"
 - "neuroscience"

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2018-2022, Stefan Appelhoff
+Copyright (c) 2018-2022, Stefan Appelhoff et al. (see CITATION.cff)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,8 +1,10 @@
 [![DOI](https://zenodo.org/badge/136149692.svg)](https://zenodo.org/badge/latestdoi/136149692)
+[![CircleCI docs](https://circleci.com/gh/sappelhoff/eeg_positions/tree/main.svg?style=shield)](https://circleci.com/gh/sappelhoff/eeg_positions/tree/main)
 [![Python build and test and deploy](https://github.com/sappelhoff/eeg_positions/workflows/Python%20build%20and%20test%20and%20deploy/badge.svg)](https://github.com/sappelhoff/eeg_positions/actions?query=workflow%3A%22Python+build+and+test+and+deploy%22)
 [![Coverage](https://codecov.io/gh/sappelhoff/eeg_positions/branch/main/graph/badge.svg)](https://codecov.io/gh/sappelhoff/eeg_positions)
 [![Latest PyPI release](https://img.shields.io/pypi/v/eeg_positions.svg)](https://pypi.org/project/eeg_positions/)
 
+
 # eeg_positions
 
 Compute and plot standard EEG electrode positions.
@@ -19,7 +21,7 @@ There are two common ways to make use of this repository:
 1. Use `eeg_positions` as a Python package (install through `pip install eeg_positions`),
    and then obtain the EEG electrode positions through the `get_elec_coords` function.
    See the [Examples](https://stefanappelhoff.com/eeg_positions/auto_examples/index.html)
-   and [API documentation](https://stefanappelhoff.com/eeg_positions/api.html)
+   and [API documentation](https://stefanappelhoff.com/eeg_positions/api.html).
 
 # Cite
 

docs/changes.rst

@@ -4,25 +4,28 @@
 Changelog
 =========
 
-v2.1.0 (unreleased)
--------------------
-- nothing yet
+.. _Stefan Appelhoff: https://stefanappelhoff.com/
+.. _Clemens Brunner: https://github.com/cbrnr
 
-v2.0.0 (2021-02-13)
--------------------
-- documentation pages are available
-- ``eeg_positions`` is a package on `PyPI <https://pypi.org/project/eeg-positions/>`_
-- a consistent API is available and documented
-- several modules have been renamed and restructured
-- users have a choice of where to place the equator of the sphere
-- ``eeg_positions`` now has an in-built (optional) integration with MNE-Python
-- test suite is now run through the GitHub actions continuous integration service
-- alias locations that are not part of the 5% system are now available (e.g., M1, A1)
+2.1.0 (unreleased)
+------------------
+- Add a ``show_axis`` parameter to :func:`eeg_positions.plot_coords`, by `Clemens Brunner`_ (:github:`#7`)
 
-v1.0.0 (2020-03-19)
--------------------
-- first git tagged release
+2.0.0 (2021-02-13)
+------------------
+- documentation pages are available, by `Stefan Appelhoff`_
+- ``eeg_positions`` is a package on `PyPI <https://pypi.org/project/eeg-positions/>`_, by `Stefan Appelhoff`_
+- a consistent API is available and documented, by `Stefan Appelhoff`_
+- several modules have been renamed and restructured, by `Stefan Appelhoff`_
+- users have a choice of where to place the equator of the sphere, by `Stefan Appelhoff`_
+- ``eeg_positions`` now has an in-built (optional) integration with MNE-Python, by `Stefan Appelhoff`_
+- test suite is now run through the GitHub actions continuous integration service, by `Stefan Appelhoff`_
+- alias locations that are not part of the 5% system are now available (e.g., M1, A1), by `Stefan Appelhoff`_
 
-v0.0.0 (2018-06-05)
--------------------
-- initial commit to the repository
+1.0.0 (2020-03-19)
+------------------
+- first git tagged release, by `Stefan Appelhoff`_
+
+0.0.0 (2018-06-05)
+------------------
+- initial commit to the repository, by `Stefan Appelhoff`_

docs/conf.py

@@ -2,8 +2,6 @@
 
 See: https://www.sphinx-doc.org/en/master/usage/configuration.html
 """
-# Copyright (c) 2018-2022, Stefan Appelhoff
-# BSD-3-Clause
 
 import os
 import sys
@@ -25,8 +23,12 @@
     "numpydoc",
     "sphinx_copybutton",
     "sphinxcontrib.bibtex",
+    "sphinx_github_role",
 ]
 
+# configure sphinx-github-role
+github_default_org_project = ("sappelhoff", "eeg_positions")
+
 # configure sphinxcontrib.bibtex
 bibtex_bibfiles = ["references.bib"]
 
@@ -63,7 +65,12 @@
 
 # General information about the project.
 project = "eeg_positions"
-copyright = "2018-{}, Stefan Appelhoff".format(date.today().year)
+copyright = (
+    f"2018-{date.today().year}, Stefan Appelhoff et al. (see "
+    "<a href='https://github.com/sappelhoff/eeg_positions/blob/main/CITATION.cff'"
+    ">CITATION.cff</a>)"
+)
+
 author = "Stefan Appelhoff"
 version = eeg_positions.__version__
 release = version

docs/index.rst

@@ -107,7 +107,7 @@ and obtain the appropriate citation from the *"Cite as"* section there.
 Acknowledgements
 ================
 
-My thanks to:
+Thanks to:
 
 - Robert Oostenveld for writing his blog post on EEG electrode positions
 
@@ -116,7 +116,7 @@ My thanks to:
   "intermediate points on a great circle" (see also :footcite:`edwilliams`)
 
 
-- "Nominal Animal" who helped me to figure out the math for
+- "Nominal Animal" who helped figure out the math for
   the ``find_point_at_fraction`` function :footcite:`stackexchange-nominal`
 
 References

eeg_positions/__init__.py

@@ -1,6 +1,4 @@
 """Compute and plot standard EEG electrode positions."""
-# Copyright (c) 2018-2022, Stefan Appelhoff
-# BSD-3-Clause
 
 __version__ = "2.1.0.dev0"
 

eeg_positions/compute.py

@@ -1,6 +1,4 @@
 """Calculate standard EEG electrode positions on a sphere."""
-# Copyright (c) 2018-2022, Stefan Appelhoff
-# BSD-3-Clause
 
 import ast
 import os

eeg_positions/config.py

@@ -1,6 +1,4 @@
 """Defining all horizontal, sagittal, and coronal contours and 10XX systems."""
-# Copyright (c) 2018-2022, Stefan Appelhoff
-# BSD-3-Clause
 
 import pkg_resources