Misc Housekeeping

.github/workflows/deploy.yml

@@ -0,0 +1,29 @@
+name: deploy
+
+on:
+ push:
+ tags:
+ - '*'
+
+jobs:
+
+ pypi:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Setup Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3.11
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip setuptools wheel build
+ - name: Build
+ run: |
+ python -m build
+ - name: Publish
+ if: success()
+ uses: pypa/[email protected]
+ with:
+ user: __token__
+ password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/python-package.yml

@@ -1,25 +1,57 @@
 name: Tests
 
 on:
- push:
+ pull_request:
+ branches:
+ - '**'
 
 jobs:
- check:
- runs-on: ubuntu-latest
+ test:
  strategy:
+ fail-fast: false
  matrix:
- python-version: [3.7, 3.8, 3.9, 3.10, pypy-3.6, pypy-3.7]
+ os: [ubuntu-latest, windows-latest, macos-latest]
+ python-version: [3.8, 3.9, '3.10', 3.11, pypy-3.8, pypy-3.9, pypy-3.10]
+ runs-on: ${{ matrix.os }}
  steps:
  - uses: actions/checkout@v2
- - name: Set up Python ${{ matrix.python-version }}
+ - name: Setup Python ${{ matrix.python-version }}
  uses: actions/setup-python@v2
  with:
  python-version: ${{ matrix.python-version }}
- - name: Install system dependencies
- run: |
- sudo gem install chef-utils -v 16.6.14
- sudo gem install mdl
  - name: Install dependencies
- run: python -m pip --disable-pip-version-check install tox
- - name: Test with tox
- run: tox
+ run: |
+ python -m pip install --upgrade pip coverage markdown
+ - name: Run tests
+ run: |
+ coverage run test_gh_links.py
+ - name: Generate coverage report
+ if: success()
+ run: |
+ coverage xml
+ coverage report --show-missing --include=mdx_gh_links.py
+ - name: Upload Results
+ if: success()
+ uses: codecov/codecov-action@v1
+ with:
+ file: ./coverage.xml
+ flags: unittests
+ name: ${{ matrix.os }}/Python ${{ matrix.python-version }}
+ fail_ci_if_error: false
+
+ flake8:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: TrueBrain/actions-flake8@master
+ with:
+ max_line_length: 118
+
+ mdlint:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: DavidAnson/markdownlint-cli2-action@v11
+ with:
+ config: '.markdownlint.jsonc'
+ globs: '**/*.md'

.markdownlint.jsonc

@@ -0,0 +1,11 @@
+// Markdownlint rules
+{
+
+ "default": true,
+
+ // Disable line length check for tables and code blocks
+ "MD013": {
+ "code_blocks": false,
+ "tables": false
+ }
+}

README.md

@@ -142,6 +142,10 @@ defined in `LICENSE`.
 
 ## Change Log
 
+### Version 0.3.1 (2023/07/28)
+
+Include README in release.
+
 ### Version 0.3 (2022/07/18)
 
 Update dependencies.

pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+# Minimum requirements for the build system to execute.
+requires = ["setuptools>=61.2", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = 'mdx_gh_links'
+version = '0.3.1'
+description = "An extension to Python-Markdown which adds support for shorthand links to GitHub users, repositories, issues and commits."
+readme = {file = 'README.md', content-type='text/markdown'}
+authors = [
+ {name = 'Waylan limberg', email = '[email protected]'}
+]
+license = {file = 'LICENSE'}
+dependencies = [
+ "markdown>=3.0.0"
+]
+keywords = ['markdown', 'python-markdown', 'github']
+classifiers = [
+ 'Development Status :: 4 - Beta',
+ 'License :: OSI Approved :: BSD License',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python',
+ 'Programming Language :: Python :: 3',
+ 'Programming Language :: Python :: 3.8',
+ 'Programming Language :: Python :: 3.9',
+ 'Programming Language :: Python :: 3.10',
+ 'Programming Language :: Python :: 3.11',
+ 'Programming Language :: Python :: Implementation :: CPython',
+ 'Programming Language :: Python :: Implementation :: PyPy',
+ 'Topic :: Documentation',
+ 'Topic :: Text Processing',
+ 'Topic :: Text Processing :: Markup',
+ 'Topic :: Text Processing :: Markup :: HTML'
+]
+
+[project.urls]
+'Homepage' = 'https://pypi.org/project/mdx-gh-links/'
+'Repository' = 'https://github.com/Python-Markdown/github-links'
+'Issue Tracker' = 'https://github.com/Python-Markdown/github-links/issues'
+
+[tool.setuptools]
+py-modules = ['mdx_gh_links']