Initial commit

.github/workflows/tests.yml

@@ -0,0 +1,97 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+    tags:
+      - 'v*'
+  pull_request:
+
+jobs:
+
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - uses: pre-commit/[email protected]
+
+  tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+        os: [ubuntu-latest, windows-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Installation (deps and package)
+      # we install with flit --pth-file,
+      # so that coverage will be recorded for the module
+      run: |
+        pip install flit
+        flit install --deps=production --extras=test --pth-file
+
+    - name: Run pytest
+      run: |
+        pytest --cov=mdformat_plugin --cov-report=xml --cov-report=term-missing
+
+    - name: Upload to Codecov
+      if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.7
+      uses: codecov/codecov-action@v1
+      with:
+        name: pytests-py3.7
+        flags: pytests
+        file: ./coverage.xml
+        fail_ci_if_error: true
+
+  pre-commit-hook:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.7
+
+    - name: Installation (deps and package)
+      run: |
+        pip install pre-commit
+        pip install .
+
+    - name: run pre-commit with plugin
+      run: |
+        pre-commit run --config .pre-commit-test.yaml --all-files --verbose --show-diff-on-failure
+
+  publish:
+    name: Publish to PyPi
+    needs: [pre-commit, tests, pre-commit-hook]
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: install flit
+      run: |
+        pip install flit~=3.0
+    - name: Build and publish
+      run: |
+        flit publish
+      env:
+        FLIT_USERNAME: __token__
+        FLIT_PASSWORD: ${{ secrets.PYPI_KEY }}

.gitignore

@@ -0,0 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# VS Code
+.vscode/

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.4.0
+  hooks:
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+  - id: trailing-whitespace
+  - id: check-yaml
+  - id: check-toml
+- repo: https://github.com/pre-commit/pygrep-hooks
+  rev: v1.8.0
+  hooks:
+  - id: python-check-blanket-noqa
+- repo: https://github.com/timothycrosley/isort
+  rev: 5.8.0
+  hooks:
+  - id: isort
+- repo: https://github.com/psf/black
+  rev: 20.8b1
+  hooks:
+  - id: black
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 3.9.0
+  hooks:
+  - id: flake8
+    additional_dependencies:
+    - flake8-bugbear==21.3.2
+    - flake8-builtins==1.5.3
+    - flake8-comprehensions==3.4.0

.pre-commit-test.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: local
+    hooks:
+    - id: mdformat
+      name: mdformat
+      entry: mdformat
+      files: "tests/pre-commit-test.md"
+      types: [markdown]
+      language: system

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Executable Books
+
+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,83 @@
+# mdformat-plugin
+
+[![Build Status][ci-badge]][ci-link]
+[![codecov.io][cov-badge]][cov-link]
+[![PyPI version][pypi-badge]][pypi-link]
+
+An [mdformat](https://github.com/executablebooks/mdformat) plugin for...
+
+## Required changes for a new plugin
+
+This demonstration is setup with a plugin named `plugin`.
+There are a number of locations to change.
+At a top level for a plugin `foo` at least the following changes are required
+
+- Global find and replace `mdformat_plugin` to `mdformat_foo` including folder names.
+- Global find and replace `mdformat-plugin` to `mdformat-foo` including folder names.
+- `tests/test_fixtures.py`: `output = mdformat.text(text, extensions={"plugin"})` becomes `output = mdformat.text(text, extensions={"foo"})`
+- `pyproject.toml` in addition to the global find and replace: `plugin = "mdformat_plugin"` becomes `foo = "mdformat_foo"`
+
+Do not forget to update authorship / maintainers in `pyproject.toml` as well.
+
+## Development
+
+This package utilises [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.
+
+To install these development dependencies:
+
+```bash
+pip install tox
+```
+
+To run the tests:
+
+```bash
+tox
+```
+
+and with test coverage:
+
+```bash
+tox -e py37-cov
+```
+
+The easiest way to write tests, is to edit tests/fixtures.md
+
+To run the code formatting and style checks:
+
+```bash
+tox -e py37-pre-commit
+```
+
+or directly
+
+```bash
+pip install pre-commit
+pre-commit run --all
+```
+
+To run the pre-commit hook test:
+
+```bash
+tox -e py37-hook
+```
+
+## Publish to PyPi
+
+Either use flit directly:
+
+```bash
+pip install flit
+flit publish
+```
+
+or trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1`.
+
+Note, this requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`.
+
+[ci-badge]: https://github.com/executablebooks/mdformat-plugin/workflows/CI/badge.svg?branch=master
+[ci-link]: https://github.com/executablebooks/mdformat/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush
+[cov-badge]: https://codecov.io/gh/executablebooks/mdformat-plugin/branch/master/graph/badge.svg
+[cov-link]: https://codecov.io/gh/executablebooks/mdformat-plugin
+[pypi-badge]: https://img.shields.io/pypi/v/mdformat-plugin.svg
+[pypi-link]: https://pypi.org/project/mdformat-plugin

mdformat_plugin/__init__.py

@@ -0,0 +1,5 @@
+"""An mdformat plugin for..."""
+
+__version__ = "0.0.1"
+
+from .plugin import RENDERERS, update_mdit  # noqa: F401