Update README, LICENSE, and yaml workflow files

This commit is contained in:
Pawel Sikora 2021-04-23 20:04:21 +02:00
parent 0120ec2e07
commit fa283ffaff
7 changed files with 88 additions and 19 deletions

26
.codecov.yaml Normal file
View File

@ -0,0 +1,26 @@
comment: false
coverage:
status:
project:
default:
# Commits pushed to master should not make the overall
# project coverage decrease by more than x%:
target: auto
threshold: 20%
patch:
default:
# Be tolerant on slight code coverage diff on PRs to limit
# noisy red coverage status on github PRs.
# Note: The coverage stats are still uploaded
# to codecov so that PR reviewers can see uncovered lines
target: auto
threshold: 20%
codecov:
notify:
# Prevent coverage status to upload multiple times for parallel and long
# running CI pipelines. This configuration is particularly useful on PRs
# to avoid confusion. Note that this value is set to the number of Azure
# Pipeline jobs uploading coverage reports.
after_n_builds: 6

35
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,35 @@
repos:
- repo: local
hooks:
- id: black
name: black
entry: black
language: python
types: [python]
language_version: python3.7
args: [--line-length=120]
- repo: local
hooks:
- id: mypy
name: mypy
entry: mypy
language: system
types: [python]
args: [--ignore-missing-imports, --namespace-packages, --show-error-codes, --pretty]
- repo: local
hooks:
- id: flake8
name: flake8
entry: flake8
language: system
types: [python]
args: [--max-line-length=120, "--ignore=D101,D104,D212,D200,E203,W293,D412,W503"]
# D100 requires all Python files (modules) to have a "public" docstring even if all functions within have a docstring.
# D104 requires __init__ files to have a docstring
# D212
# D200
# D412 No blank lines allowed between a section header and its content
# E203
# W293 blank line contains whitespace
# W503 line break before binary operator (for compatibility with black)

4
.travis.yml Normal file
View File

@ -0,0 +1,4 @@
language:
python
after_success:
- bash <(curl -s https://codecov.io/bash)

View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2021 pawelsikora
Copyright (c) 2020 Pawel Sikora
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@ -1,3 +1,10 @@
[![Actions Status](https://github.com/pawelsikora/mkdocs-with-confluence/workflows/pytest/badge.svg)](https://github.com/pawelsikora/mkdocs-with-confluence/actions)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-with-confluence)
![PyPI](https://img.shields.io/pypi/v/mkdocs-with-confluence)
![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-with-confluence)
[![codecov](https://codecov.io/gh/pawelsikora/mkdocs-with-confluence/branch/master/graph/badge.svg)](https://codecov.io/gh/pawelsikora/mkdocs-with-confluence)
![GitHub contributors](https://img.shields.io/github/contributors/pawelsikora/mkdocs-with-confluence)
![PyPI - License](https://img.shields.io/pypi/l/mkdocs-with-confluence
# mkdocs-with-confluence
MkDocs plugin that converts markdown pages into confluence markup

4
requirements.txt Normal file
View File

@ -0,0 +1,4 @@
pre-commit
mimetypes
mistune
md2cf

View File

@ -1,23 +1,16 @@
from setuptools import setup, find_packages
setup(
name='mkdocs-with-confluence',
version='0.1.0',
description='MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API',
keywords='mkdocs markdown confluence documentation rest python',
url='https://github.com/pawelsikora/mkdocs-with-confluence/',
author='Pawel Sikora',
author_email='sikor6@gmail.com',
license='MIT',
python_requires='>=3.6',
install_requires=[
'mkdocs>=1.1',
'jinja2'
],
name="mkdocs-with-confluence",
version="0.1.1",
description="MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API",
keywords="mkdocs markdown confluence documentation rest python",
url="https://github.com/pawelsikora/mkdocs-with-confluence/",
author="Pawel Sikora",
author_email="sikor6@gmail.com",
license="MIT",
python_requires=">=3.6",
install_requires=["mkdocs>=1.1", "jinja2"],
packages=find_packages(),
entry_points={
'mkdocs.plugins': [
'mkdocs-with-confluence = mkdocs_with_confluence.plugin:MkdocsWithConfluence'
]
}
entry_points={"mkdocs.plugins": ["mkdocs-with-confluence = mkdocs_with_confluence.plugin:MkdocsWithConfluence"]},
)