Update README, LICENSE, and yaml workflow files
This commit is contained in:
parent
0120ec2e07
commit
fa283ffaff
|
@ -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
|
|
@ -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)
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
language:
|
||||||
|
python
|
||||||
|
after_success:
|
||||||
|
- bash <(curl -s https://codecov.io/bash)
|
2
LICENSE
2
LICENSE
|
@ -1,6 +1,6 @@
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2021 pawelsikora
|
Copyright (c) 2020 Pawel Sikora
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|
|
@ -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-with-confluence
|
||||||
|
|
||||||
MkDocs plugin that converts markdown pages into confluence markup
|
MkDocs plugin that converts markdown pages into confluence markup
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
pre-commit
|
||||||
|
mimetypes
|
||||||
|
mistune
|
||||||
|
md2cf
|
29
setup.py
29
setup.py
|
@ -1,23 +1,16 @@
|
||||||
from setuptools import setup, find_packages
|
from setuptools import setup, find_packages
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='mkdocs-with-confluence',
|
name="mkdocs-with-confluence",
|
||||||
version='0.1.0',
|
version="0.1.1",
|
||||||
description='MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API',
|
description="MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API",
|
||||||
keywords='mkdocs markdown confluence documentation rest python',
|
keywords="mkdocs markdown confluence documentation rest python",
|
||||||
url='https://github.com/pawelsikora/mkdocs-with-confluence/',
|
url="https://github.com/pawelsikora/mkdocs-with-confluence/",
|
||||||
author='Pawel Sikora',
|
author="Pawel Sikora",
|
||||||
author_email='sikor6@gmail.com',
|
author_email="sikor6@gmail.com",
|
||||||
license='MIT',
|
license="MIT",
|
||||||
python_requires='>=3.6',
|
python_requires=">=3.6",
|
||||||
install_requires=[
|
install_requires=["mkdocs>=1.1", "jinja2"],
|
||||||
'mkdocs>=1.1',
|
|
||||||
'jinja2'
|
|
||||||
],
|
|
||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
entry_points={
|
entry_points={"mkdocs.plugins": ["mkdocs-with-confluence = mkdocs_with_confluence.plugin:MkdocsWithConfluence"]},
|
||||||
'mkdocs.plugins': [
|
|
||||||
'mkdocs-with-confluence = mkdocs_with_confluence.plugin:MkdocsWithConfluence'
|
|
||||||
]
|
|
||||||
}
|
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in New Issue