Initial commit

.coveragerc

@@ -0,0 +1,7 @@
+[run]
+source = fillname
+omit = */fillname/__main__.py
+[report]
+exclude_lines =
+    assert
+    nocoverage

.envrc

@@ -0,0 +1,10 @@
+# automatically activate dev environment when in project tree using direnv.
+ACT=.nox/dev/bin/activate
+
+if [ -e $ACT ]
+then
+    source $ACT
+else
+    echo "Activation script ${ACT} not found for dev environment.
+Run nox -s dev to install dev environment"
+fi

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+max-line-length = 120
+exclude =
+    .git
+    .github
+ignore = E741

.github/workflows/ci-test.yml

@@ -0,0 +1,40 @@
+name: Run CI tests
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+
+env:
+  FORCE_COLOR: "3"
+
+jobs:
+  build:
+    name: test on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+
+    steps:
+    - name: "checkout repository"
+      uses: actions/checkout@v3
+
+    - name: "setup python 3.7"
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.7
+
+    - name: "setup python 3.11"
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.11
+
+    - name: install nox
+      run: python -m pip install nox
+
+    - name: run tests
+      run: nox

.gitignore

@@ -0,0 +1,36 @@
+# Editors
+.vscode/
+*~
+\#*\#
+.\#*
+
+# Mac/OSX
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+*egg-info*
+
+# unclassified
+dist
+build
+.coverage
+_build
+_autosummary

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile = black

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/myint/autoflake
+    rev: v1.4
+    hooks:
+    - id: autoflake
+      args: ["--in-place",  "--imports=fillname", "--ignore-init-module-imports", "--remove-unused-variables"]
+      exclude: ^.github/
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+      exclude: ^.github/
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.11.5
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+        exclude: ^.github/
+
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+    - id: black
+      exclude: ^.github/

.pylintrc

@@ -0,0 +1,31 @@
+[FORMAT]
+
+max-line-length=120
+
+[DESIGN]
+
+max-args=10
+max-attributes=7
+max-bool-expr=5
+max-branches=12
+max-locals=30
+max-parents=7
+max-public-methods=20
+max-returns=10
+max-statements=50
+min-public-methods=1
+
+[SIMILARITIES]
+
+ignore-comments=yes
+ignore-docstrings=yes
+ignore-imports=yes
+ignore-signatures=yes
+
+[BASIC]
+
+argument-rgx=^[a-z][a-z0-9]*((_[a-z0-9]+)*_?)?$
+variable-rgx=^[a-z][a-z0-9]*((_[a-z0-9]+)*_?)?$
+
+# Good variable names which should always be accepted, separated by a comma.
+good-names=_,M,N,B,A,Nn,Bn,An

.readthedocs.yaml

@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: setuptools
+      path: .[doc]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Susana Hahn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,84 @@
+# fillname
+
+This project template is configured to ease collaboration. Linters, formatters,
+and actions are already configured and ready to use.
+
+To use the project template, run the `init.py` script to give the project a
+name and some metadata. The script can then be removed afterward and the
+`setup.cfg` file adjusted.
+
+## Installation
+
+```shell
+pip install fillname
+```
+
+## Usage
+
+```shell
+fillname -h
+```
+
+## Development
+
+To improve code quality, we run linters, type checkers, and unit tests. The
+tools can be run using [nox]. We recommend installing nox using [pipx] to have
+it available globally:
+
+```bash
+python -m pip install pipx
+python -m pipx install nox
+nox
+```
+
+You can invoke `nox -s` to run individual sessions. For example, to install
+your package into a virtual environment and run your test suite, invoke:
+
+```bash
+nox -s test
+```
+
+We also provide a nox session that creates an environment for development. The
+project is installed in [editable] mode into this environment along with
+linting, type checking and formatting tools. Activating it allows your editor
+of choice to access these tools for, e.g., linting and autocompletion. To
+create and then activate virtual environment run:
+
+```bash
+nox -s dev
+source .nox/dev/bin/activate
+```
+
+Furthermore, we provide individual sessions to easily run linting, type
+checking and formatting via nox. These also create editable installs. So you
+can safely skip the recreation of the virtual environment and reinstallation of
+your package in subsequent runs by passing the `-R` command line argument. For
+example, to auto-format your code using [black], run:
+
+```bash
+nox -Rs format -- check
+nox -Rs format
+```
+
+The former command allows you to inspect changes before applying them.
+
+Note that editable installs have some caveats. In case there are issues, try
+recreating environments by dropping the `-R` option. If your project is
+incompatible with editable installs, adjust the `noxfile.py` to disable them.
+
+We also provide a [pre-commit][pre] config to automate this process. It can be
+set up using the following commands:
+
+```bash
+python -m pipx install pre-commit
+pre-commit install
+```
+
+This blackens the source code whenever `git commit` is used.
+
+[doc]: https://potassco.org/clingo/python-api/current/
+[nox]: https://nox.thea.codes/en/stable/index.html
+[pipx]: https://pypa.github.io/pipx/
+[pre]: https://pre-commit.com/
+[black]: https://black.readthedocs.io/en/stable/
+[editable]: https://setuptools.pypa.io/en/latest/userguide/development_mode.html

doc/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     = .
+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)