Assorted changes and a couple of fixes to the fancy sheets

.github/workflows/docker.yml

@@ -1,15 +1,22 @@
-name: Docker
+name: Deploy Docker image
 
 on:
-  push:
-    branches: [ "master" ]
+  workflow_run:
+    workflows: ["Python package"]
+    branches: ["master"]
+    types:
+      - completed
+
+  workflow_dispatch:
 
 env:
   REGISTRY: ghcr.io
   IMAGE_NAME: ${{ github.repository }}
+  VERSION: latest
 
 jobs:
-  build_publish:
+  build:
+    name: Build Docker image
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -29,7 +36,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: Login against Container registry
+      - name: Login to container registry
         uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
@@ -42,11 +49,78 @@ jobs:
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
-      - name: Build and push Docker image
+      - name: Build Docker image
         uses: docker/build-push-action@v5
         with:
           context: .
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           platforms: linux/amd64, linux/arm64
+
+  test:
+    name: Test Docker image
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
+    strategy:
+      matrix:
+        build-command: ["", "--fancy --tex-template --feats-by-type --spells-by-level", "--output-format=epub"]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Login to container registry
+      uses: docker/login-action@v3
+      with:
+        registry: ${{ env.REGISTRY }}
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Extract metadata (tags, labels) for Docker
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+    - name: Run Tests
+      run: |
+        docker run -v ${{ github.workspace }}/examples:/build ${{ steps.meta.outputs.tags }} ${{ matrix.build-command }}
+
+  push:
+    name: Deploy Docker image
+    needs: [build, test]
+    if: ${{ github.ref  == 'refs/heads/master' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+
+      - name: Login to container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Pull Docker image from GHCR
+        run: docker pull ${{ steps.meta.outputs.tags }}
+
+      - name: Lowercase reponame
+        run: echo "IMAGE_NAME_LC=${GITHUB_REPOSITORY@L}" >> "${GITHUB_ENV}"
+
+      - name: Tag and push Docker image to GHCR (final)
+        run: |
+          docker tag  ${{ steps.meta.outputs.tags }} ${{ env.REGISTRY }}/${{ env.IMAGE_NAME_LC }}:${{ env.VERSION }}
+          docker push  ${{ steps.meta.outputs.tags }}
+          docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME_LC }}:${{ env.VERSION }}

.github/workflows/python_ci.yml

@@ -0,0 +1,84 @@
+name: Python package
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: "Run test suite"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+
+    - name: Set up required system dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install pdftk texlive-latex-base texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra texlive-luatex texlive-pstricks
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: pip
+
+    - name: Install dependencies and do a local pip install
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+
+    - name: Run flake
+      run: flake8 dungeonsheets/ --exit-zero
+
+    - name: Run tests
+      run: pytest --cov=dungeonsheets tests/
+
+  render_examples:
+    name: "Test python-3.12, render all examples"
+    runs-on: ubuntu-latest
+    needs: [build]
+    strategy:
+      matrix:
+        build-command: ["", "--fancy --tex-template --spells-by-level --feats-by-type", "--output-format=epub"]
+
+    steps:
+    - uses: actions/checkout@v4
+      name: Checkout Repo
+      with:
+        submodules: recursive
+
+    - name: Set up required system dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install pdftk texlive-latex-base texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra texlive-luatex texlive-pstricks
+
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+        cache: pip
+
+    - name: Install dependencies and do a local pip install
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+
+    - name: Run flake
+      run: flake8 dungeonsheets/ --exit-zero
+
+    - name: Run tests
+      run: pytest --cov=dungeonsheets tests/
+
+    - name: Render examples with ${{ matrix.build-command }}
+      run: |
+        cd examples
+        makesheets --debug ${{ matrix.build-command }}

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "dungeonsheets/modules/DND-5e-LaTeX-Template"]
 	path = dungeonsheets/modules/DND-5e-LaTeX-Template
 	url = https://github.com/rpgtex/DND-5e-LaTeX-Template.git
+[submodule "dungeonsheets/modules/DND-5e-LaTeX-Character-Sheet-Template"]
+	path = dungeonsheets/modules/DND-5e-LaTeX-Character-Sheet-Template
+	url = https://github.com/matsavage/DND-5e-LaTeX-Character-Sheet-Template

Dockerfile

@@ -1,6 +1,6 @@
 FROM python:latest
 
-RUN apt-get update && apt-get install -y pdftk texlive-latex-base texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra
+RUN apt-get update && apt-get install -y pdftk texlive-latex-base texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra texlive-luatex texlive-pstricks
 
 WORKDIR /app
 

README.rst

@@ -36,7 +36,7 @@ Run the following in a directory with valid character files (such as the example
 
 .. code:: bash
 
-    $ docker run -it -v $(pwd):/build ghcr.io/canismarko/dungeon-sheets:master
+    $ docker run -it -v $(pwd):/build ghcr.io/canismarko/dungeon-sheets:latest
 
 
 Installation
@@ -48,7 +48,7 @@ Installation
 
 .. note::
 
-   Dungeon sheets requires **at least python 3.6**. This is mostly due
+   dungeon-sheets requires **at least python 3.6**. This is mostly due
    to the liberal use of f-strings_. If you want to use it with
    previous versions of python 3, you'll probably have to replace all
    the f-strings with the older ``.format()`` method or string
@@ -72,8 +72,9 @@ pdftk is available in Debian and derivatives as **pdftk**, the package
 is not available in some RPM distributions, such as Fedora and CentOS.
 One alternative would be to build your PC sheets using docker.
 
-If the ``pdflatex`` command is available on your system, spellcasters
-will include a spellbook with descriptions of each spell known. If
+If the ``pdflatex`` command is available on your system, dungeon-sheets
+will include a description of a character's features. For spellcasters,
+it will include a spellbook with descriptions of each spell known. If
 not, then this feature will be skipped.
 
 In order to properly format descriptions for spells/features/etc.,
@@ -109,12 +110,29 @@ so attack bonuses and damage can be calculated automatically.
 
 Consider using the ``-F`` option to include the excellent D&D 5e
 template for rendering spellbooks, druid wild forms and features
-pages (https://github.com/rpgtex/DND-5e-LaTeX-Template).
+pages (https://github.com/rpgtex/DND-5e-LaTeX-Template). dungeon-
+sheets includes its own version of the template, but will use a
+local one if it is installed.
+
+Consider using the ``-T`` option to use the beautiful latex character
+sheet
+(https://github.com/matsavage/DND-5e-LaTeX-Character-Sheet-Template).
+This does require lualatex as well as a fairly recent version of
+texlive. dungeon-sheets includes its own version of the latex character
+template, but will use a local one if it is installed.
 
 By default, your character's spells are ordered alphabetically. If you
 would like your spellbook to be ordered by level, you can use the ``-S``
 option to do so.
 
+Furthermore, your character's features are ordered alphabetically by
+default as well. Pass the ``-N`` option to order feats by type
+(character feats, class feats, racial feats and background feat) and,
+if applicable, by sub-type (e.g., for Sorcerers, metamagic feature
+choices are collected under the Metamagic feature; for the Battle
+Master subclass, Maneuver feature choices are collected under
+the Combat Superiority feature.)
+
 If you'd like a **step-by-step walkthrough** for creating a new
 character, just run ``create-character`` from a command line and a
 helpful menu system will take care of the basics for you.
@@ -130,7 +148,7 @@ properly parsed and rendered into LaTeX or HTML::
 
   class Scrying(Spell):
     """You can see and hear a particular creature you choose that is on
-    the same plane of existence as you. The target must make a W isdom
+    the same plane of existence as you. The target must make a Wisdom
     saving throw, which is modified by how well you know the target
     and the sort of physical connection you have to it. If a target
     knows you're casting this spell, it can fail the saving throw

docs/character_files.rst

@@ -20,7 +20,7 @@ Each character file must contain a line like::
 
   dungeonsheets_version = "0.4.2"
 
-Without this line, the :ref:`makesheets` command-line utility will ignore
+Without this line, the :ref:`makesheets<Usage>` command-line utility will ignore
 the file. This is necessary to avoid importing non-D&D python files.
 
 .. note::

docs/conf.py

@@ -63,7 +63,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -90,7 +90,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

dungeonsheets/background.py

@@ -103,7 +103,7 @@ class Outlander(Background):
 class RivalIntern(Background):
     """You were an intern at a rival of Acquisitions Incorporated, and you
     gained a healthy respect for nocjusc the job and the franchising
-    opportunities. but for the ruth- less and efficient way
+    opportunities. but for the ruthless and efficient way
     Acquisitions Incorporated goes about its business. Why deal with
     the rest, when you can work for the best?
 
@@ -117,7 +117,7 @@ class RivalIntern(Background):
 
     name = "Rival Intern"
     skill_proficiencies = ("history", "investigation")
-    proficiencies_text = ("One type of artisan's tools",)
+    proficiencies_text = ("[choose one type of artisan's tools]",)
     languages = ("[choose one]",)
     features = (feats.InsideInformant,)
 
@@ -263,6 +263,7 @@ class Faceless(Background):
     about you prevents you from effectively pursuing the path you've chosen.
     Even so, that doesn't stop you. You've left your old face behind, taking on
     a new persona, becoming something more.
+
     Characters with the faceless background don a disguise (literally or
     otherwise) as they adventuree. This persona might be dramatic or subtle. In
     a way, though, many characters have such larger than life personalities.