Merge pull request #44 from cadenmyers13/cookierelease

Cookiecutter

.codecov.yml

@@ -0,0 +1,34 @@
+# codecov can find this file anywhere in the repo, so we don't need to clutter
+# the root folder.
+#comment: false
+
+codecov:
+  notify:
+    require_ci_to_pass: no
+
+coverage:
+  status:
+    patch:
+      default:
+        target: '70'
+        if_no_uploads: error
+        if_not_found: success
+        if_ci_failed: failure
+    project:
+      default: false
+      library:
+        target: auto
+        if_no_uploads: error
+        if_not_found: success
+        if_ci_failed: error
+        paths: '!*/tests/.*'
+
+      tests:
+        target: 97.9%
+        paths: '*/tests/.*'
+        if_not_found: success
+
+flags:
+  tests:
+    paths:
+      - tests/

.coveragerc

@@ -0,0 +1,13 @@
+[run]
+source =
+    bg_mpl_stylesheets
+[report]
+omit =
+    */python?.?/*
+    */site-packages/nose/*
+    # ignore _version.py and versioneer.py
+    .*version.*
+    *_version.py
+
+exclude_lines =
+    if __name__ == '__main__':

.gitattributes

@@ -0,0 +1 @@
+bg_mpl_stylesheets/_version.py export-subst

.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+name: Build Documentation
+
+on:
+  push:
+    branches:
+      - main
+  release:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -l {0}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: build
+          auto-update-conda: true
+
+      - name: install requirements
+        run: >-
+          conda install -n build -c conda-forge
+          --file requirements/build.txt
+          --file requirements/run.txt
+          --file requirements/docs.txt
+          --quiet --yes
+
+      - name: install the package
+        run: python -m pip install . --no-deps
+
+      - name: build documents
+        run: make -C doc html
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/build/html

.github/workflows/main.yml

@@ -0,0 +1,54 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - CI
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  miniconda:
+    name: Miniconda ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+        matrix:
+            os: ["ubuntu-latest"]
+    steps:
+      - name: check out bg-mpl-stylesheets
+        uses: actions/checkout@v3
+        with:
+          repository: bg-mpl-stylesheets/bg-mpl-stylesheets
+          path: .
+          fetch-depth: 0  # avoid shallow clone with no tags
+
+      - name: initialize miniconda
+        # this uses a marketplace action that sets up miniconda in a way that makes
+        # it easier to use.  I tried setting it up without this and it was a pain
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: test
+          # environment.yml file is needed by this action.  Because I don't want
+          # maintain this but rather maintain the requirements files it just has
+          # basic things in it like conda and pip
+          environment-file: ./environment.yml
+          python-version: 3
+          auto-activate-base: false
+
+      - name: install bg-mpl-stylesheets requirements
+        shell: bash -l {0}
+        run: |
+          conda config --set always_yes yes --set changeps1 no
+          conda config --add channels conda-forge
+          conda activate test
+          conda install --file requirements/run.txt
+          conda install --file requirements/test.txt
+          pip install .
+      - name: Validate bg-mpl-stylesheets
+        shell: bash -l {0}
+        run: |
+          conda activate test
+          coverage run -m pytest -vv -s
+          coverage report -m
+          codecov

.github/workflows/pre-commit.yml

@@ -0,0 +1,19 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+  workflow_dispatch:
+
+jobs:
+  pre-commit:
+    # pull requests are a duplicate of a branch push if within the same repo.
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+      - uses: pre-commit/action@v3.0.0
+        with:
+          extra_args: --all-files

.gitignore

@@ -1,64 +1,99 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-*.egg-info/
-.installed.cfg
-*.egg
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*,cover
-.pytest_cache/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Rever
-rever/
-
-#pycharm
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+venv/
+*.egg-info/
+.installed.cfg
+*.egg
+bin/
+temp/
+tags/
+errors.err
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+MANIFEST
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/build/
+docs/source/generated/
+
+# pytest
+.pytest_cache/
+
+# PyBuilder
+target/
+
+# Editor files
+# mac
+.DS_Store
+*~
+
+# vim
+*.swp
+*.swo
+
+# pycharm
 .idea/
+
+# VSCode
+.vscode/
+
+# Ipython Notebook
+.ipynb_checkpoints
+
+# version information
+setup.cfg
+/src/bg-mpl-stylesheets/*/version.cfg
+
+# Rever
+rever/

.isort.cfg

@@ -0,0 +1,4 @@
+[settings]
+line_length = 115
+multi_line_output = 3
+include_trailing_comma = True

.pre-commit-config.yaml

@@ -11,27 +11,27 @@ ci:
     submodules: false
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
         exclude: '\.(rst|txt)$'
-  - repo: https://github.com/ambv/black
-    rev: 23.3.0
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
     hooks:
       - id: black
   - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
+    rev: 7.0.0
     hooks:
       - id: flake8
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         args: ["--profile", "black"]
   - repo: https://github.com/kynan/nbstripout
-    rev: 0.6.1
+    rev: 0.7.1
     hooks:
       - id: nbstripout
   - repo: https://github.com/pre-commit/pre-commit-hooks

AUTHORS.rst

@@ -0,0 +1,10 @@
+Authors
+=======
+
+Billinge Group and community contibutors.
+
+Contributors
+------------
+
+For a list of contributors, visit
+https://github.com/bg-mpl-stylesheets/bg-mpl-stylesheets/graphs/contributors

CHANGELOG.rst

@@ -1,3 +1,7 @@
+=============
+Release Notes
+=============
+
 v0.1.0
 ====================
 
@@ -19,5 +23,3 @@ v0.1.0
 
 * Rever integration
 * Rever version bump patterns
-
-**Security:** None