Merge pull request #20 from max-models/version-0-1

Version 0.1

Author: max-models

.gitattributes

@@ -0,0 +1 @@
+*.ipynb filter=strip-notebook-output  

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+
+...
+
+**To Reproduce**
+
+...
+
+**Expected behavior**
+
+...
+
+**Proposed solution**
+
+...
+
+**Additional context**
+
+...

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the feature**
+
+...
+
+
+**Proposed implementation**
+
+...
+
+**Additional context**
+
+...

.github/workflows/ci_pipeline.yml

@@ -1,31 +1,40 @@
-name: Python CI
+name: Testing
 
 on:
   push:
     branches:
       - main
+      - devel
   pull_request:
     branches:
       - main
+      - devel
 
 jobs:
   test:
     runs-on: ubuntu-latest
-
+    # strategy:
+    #   matrix:
+    #     python-version: ['3.12']
     steps:
       - name: Check out the code
         uses: actions/checkout@v3
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'  # Specify the Python version, e.g., '3.8'
+      # - name: Set up Python
+      #   uses: actions/setup-python@v4
+      #   with:
+      #     python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies
+      - name: Install python dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install .
+          pip install ".[dev]"
 
       - name: Run tests
         run: |
-          pytest  # or replace with your testing command
+          coverage run -m pytest .
+          coverage report --sort=cover
+      
+      - name: Test tutorials
+        run: |
+          jupyter nbconvert --to notebook --execute tutorials/*.ipynb --output-dir=/tmp --ExecutePreprocessor.timeout=300

.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches: ["devel", "main"] # TODO: Set to main only after release
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install pandoc
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y pandoc
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[docs]"
+
+      - name: Build Sphinx docs
+        run: |
+          cd docs
+          make html
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload built docs
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html/
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish Python Package
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build the package
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__  # Use API token
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: twine upload dist/*
+

.github/workflows/static_analysis.yml

@@ -0,0 +1,62 @@
+name: Static analysis
+
+on:
+  push:
+    branches:
+      - main
+      - devel
+  pull_request:
+    branches:
+      - main
+      - devel
+
+jobs:
+  static-analysis:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Download and run cloc
+        run: |
+          curl -s https://raw.githubusercontent.com/AlDanial/cloc/master/cloc > cloc
+          chmod +x cloc
+          ./cloc --version
+          ./cloc $(git ls-files)
+
+      - name: Code formatting with black
+        run: |
+          pip install black
+          pip install "black[jupyter]"
+          black --check src/
+          black --check tutorials/
+
+      - name: Code formatting with isort
+        run: |
+          pip install isort
+          isort --check src/
+          isort --check tutorials/
+
+      - name: Code formatting with prospector
+        continue-on-error: true
+        run: |
+          pip install mypy
+          mypy src/
+
+      - name: Code formatting with prospector
+        continue-on-error: true
+        run: |
+          pip install prospector
+          prospector src/
+      
+      - name: Code formatting with ruff
+        continue-on-error: true
+        run: |
+          pip install ruff
+          ruff check src/
+
+      - name: Code formatting with pylint
+        continue-on-error: true
+        run: |
+          pip install pylint
+          pylint src/

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0  # Use the latest stable version
+    hooks:
+      - id: check-added-large-files # Prevent giant files from being committed.
+        args: ["--maxkb=1000"]     
+      - id: check-merge-conflict    # Check for files that contain merge conflict strings.
+      - id: check-toml              # Attempts to load all TOML files to verify syntax.
+      - id: check-yaml              # Attempts to load all yaml files to verify syntax.
+        args: ["--unsafe"]
+
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.8.1
+    hooks:
+      - id: nbstripout # remove jupyter notebook cell output

README.md

@@ -1,5 +1,9 @@
 # maxplotlib
 
+This is a wrapper for matplotlib so I can produce figures with consistent formatting. It also has some pretty nice additions such as using layers and exporting to tikz.
+
+Related packages: [maxtikzlib](https://github.com/max-models/maxtikzlib) and [maxtexlib](https://github.com/max-models/maxtexlib).
+
 ## Install
 
 Create and activate python environment
@@ -16,8 +20,10 @@ Install the code and requirements with pip
 pip install -e .
 ```
 
-Run the code with
+Additional dependencies for developers can be installed with
 
 ```
-maxplotlib
-```
+pip install -e ".[dev]"
+```
+
+Some examples can be found in `tutorials/`

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)