Merge pull request #3 from sappelhoff/egg

Full overhaul: eeg_positions 2.0

Author: sappelhoff

.github/workflows/python_build-test.yml …b/workflows/python_build-test-deploy.yml.github/workflows/python_build-test.yml renamed to .github/workflows/python_build-test-deploy.yml .github/workflows/python_build-test.yml renamed to .github/workflows/python_build-test-deploy.yml

@@ -1,4 +1,4 @@
-name: Python build and tests
+name: Python build and test and deploy
 
 on:
   push:
@@ -19,7 +19,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v1
       with:
-        python-version: 3.6
+        python-version: 3.7
 
     - name: Update pip, setuptools, and wheel
       run: python -m pip install --upgrade pip setuptools wheel
@@ -53,9 +53,10 @@ jobs:
       fail-fast: false
       matrix:
         platform: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.6]
+        python-version: [3.7]
 
     runs-on: ${{ matrix.platform }}
+    needs: [build]
 
     steps:
     - uses: actions/checkout@v2
@@ -67,21 +68,55 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install -e .[test]
+        make inplace
 
     - name: Check formatting
       if: "matrix.platform == 'ubuntu-latest'"
       run: |
-        flake8 --docstring-convention numpy .
-        check-manifest .
+        make flake
+        make check-manifest
 
     - name: Test with pytest
       run: |
-        pytest --doctest-modules --cov=eeg_positions/ --cov-report=xml --cov-config=setup.cfg --verbose -s
+        make test
 
     - name: Upload coverage report
       if: "matrix.platform == 'ubuntu-latest'"
       uses: codecov/codecov-action@v1
       with:
         file: ./coverage.xml
+
+    - name: build docs
+      if: "matrix.platform == 'ubuntu-latest'"
+      run: |
+        make build-doc
+
+    - name: Upload docs build artifacts
+      if: "matrix.platform == 'ubuntu-latest'"
+      uses: actions/upload-artifact@v2
+      with:
+        name: docs-artifact
+        path: docs/_build/html
+
+  deploy:
+
+    runs-on: ubuntu-latest
+    needs: [build, test]
+    if: github.ref == 'refs/heads/master' # only run on master
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Download docsbuild artifacts
+      uses: actions/download-artifact@v2
+      with:
+        name: docs-artifact
+        path: docs/_build/html
+
+    - name: Deploy
+      uses: JamesIves/[email protected]
+      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/workflows/python_publish.yml

@@ -0,0 +1,34 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    env:
+      TZ: Europe/Berlin
+      FORCE_COLOR: true
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install --upgrade setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.gitignore

@@ -1,3 +1,7 @@
+docs/auto_examples
+docs/generated
+.vscode
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.zenodo.json

@@ -10,6 +10,8 @@
   ],
   "license": "BSD-3-Clause",
   "upload_type": "software",
+  "access_right": "open",
+  "language": "eng",
   "creators": [
     {
       "name": "Appelhoff, Stefan",

MANIFEST.in

@@ -2,9 +2,12 @@ include MANIFEST.in
 include README.md
 include LICENSE
 include .zenodo.json
+include Makefile
 
 graft eeg_positions
+graft examples
 graft data
+graft docs
 
 ### Exclude
 
@@ -13,6 +16,9 @@ global-exclude __pycache__
 
 recursive-exclude .github *
 recursive-exclude images *.png
+recursive-exclude docs/_build *
+recursive-exclude docs/generated *
+recursive-exclude docs/auto_examples *
 
 exclude .gitignore
 exclude .coveragerc

Makefile

@@ -0,0 +1,51 @@
+.PHONY: all clean inplace test isort black format flake check-manifest pep build-doc conda
+
+all: clean inplace pep test build-doc
+
+inplace:
+	python -m pip install --upgrade pip
+	python -m pip install --editable ".[dev]" --no-cache-dir
+
+clean:
+	find . -type d -name 'eeg_positions.egg-info' -exec rm -rf {} +;
+	find . -type d -name 'dist' -exec rm -rf {} +;
+	find . -type d -name 'build' -exec rm -rf {} +;
+	find . -type d -name '__pycache__' -exec rm -rf {} +;
+	find . -type d -name '.pytest_cache' -exec rm -rf {} +;
+	find . -type f -name 'coverage.xml' -exec rm -rf {} +;
+	find . -type f -name '.coverage' -exec rm -rf {} +;
+
+test:
+	pytest --doctest-modules --doctest-ignore-import-errors --cov=eeg_positions/ --cov-report=xml --cov-config=setup.cfg --verbose -s
+
+isort:
+	isort eeg_positions
+	isort examples
+	isort docs/conf.py
+
+black:
+	black eeg_positions
+	black examples
+	black docs/conf.py
+
+format: isort black
+
+flake:
+	flake8 --docstring-convention numpy eeg_positions
+	flake8 --docstring-convention numpy examples
+
+check-manifest:
+	check-manifest .
+
+pep: flake check-manifest
+
+build-doc:
+	rm -rf docs/auto_examples
+	rm -rf docs/generated
+	cd docs; make clean
+	cd docs; make html
+	cd docs; make view
+
+conda:
+	conda env remove -n eegpos
+	conda create --yes -n eegpos Python=3.8