Skip to content

Commit 1eeaf91

Browse files
author
Hristo Valev
committed
pre-commit + readme update
1 parent ef3f839 commit 1eeaf91

File tree

3 files changed

+51
-6
lines changed

3 files changed

+51
-6
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,7 @@ __pycache__
55
build
66
debug.log
77
.vscode
8-
*coverage*
8+
*coverage*
9+
.ruff_cache
10+
.venv
11+
.pylintrc

.pre-commit-config.yaml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.5.0
4+
hooks:
5+
- id: end-of-file-fixer
6+
- id: trailing-whitespace
7+
- id: mixed-line-ending
8+
- id: check-byte-order-marker
9+
- id: check-executables-have-shebangs
10+
- id: check-merge-conflict
11+
- id: check-symlinks
12+
- id: check-vcs-permalinks
13+
- id: debug-statements
14+
- id: check-yaml
15+
files: .*\.(yaml|yml)$
16+
- repo: https://github.com/psf/black
17+
rev: "24.4.1"
18+
hooks:
19+
- id: black
20+
language_version: python3
21+
- repo: https://github.com/codespell-project/codespell
22+
rev: v2.2.4
23+
hooks:
24+
- id: codespell
25+
name: codespell
26+
description: Checks for common misspellings in text files.
27+
entry: codespell
28+
language: python
29+
types: [text]
30+
args: []
31+
require_serial: false
32+
additional_dependencies: []
33+
- repo: https://github.com/charliermarsh/ruff-pre-commit
34+
rev: v0.4.2
35+
hooks:
36+
- id: ruff
37+
args: [--fix]
38+
- repo: https://github.com/asottile/pyupgrade
39+
rev: v3.3.2
40+
hooks:
41+
- id: pyupgrade
42+
args: [--py38-plus]

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Downloads](https://static.pepy.tech/badge/py-markdown-table/month)](https://pepy.tech/project/py-markdown-table)
66
[![Downloads](https://static.pepy.tech/badge/py-markdown-table/week)](https://pepy.tech/project/py-markdown-table)
77

8-
Tiny python library with zero dependencies which generates formatted multiline tables in `markdown`.
8+
Tiny python library with zero dependencies which generates formatted multiline tables in `markdown`.
99

1010
## Basic Use
1111
Install via pip as follows: ```pip install py-markdown-table```
@@ -54,8 +54,8 @@ jokes_list = [
5454
"joke3": "How does a penguin build its house? Igloos it together!"
5555
}
5656
]
57-
markdown = markdown_table(jokes_list).set_params(padding_width = 3,
58-
padding_weight = 'centerleft',
57+
markdown = markdown_table(jokes_list).set_params(padding_width = 3,
58+
padding_weight = 'centerleft',
5959
multiline = {'joke1': 30, 'joke2': 30, 'joke3': 30}
6060
).get_markdown()
6161
```
@@ -402,7 +402,7 @@ The namespace `py_markdown_table.utils` provides the functions `count_emojis()`
402402
<summary >
403403
see example
404404
</summary>
405-
*Note:* Github's markdown preview does not render emojis as two whole characters, hence the slight offsets in cells containing emojis.
405+
*Note:* Github's markdown preview does not render emojis as two whole characters, hence the slight offsets in cells containing emojis.
406406

407407
```
408408
+-------------------------------+
@@ -435,7 +435,7 @@ Below is an example from a monospaced terminal, where the table is rendered corr
435435

436436

437437
## Benchmarks
438-
The table below provide some benchmark results, evaluating the performance on data containing incrementally larger number of `columns`, `rows`, and characters in each table cell (i.e. `cell_size`). You can benchmark it on your own system using the script contained within `py_markdown_table/utils/benchmark.py`. Generally, reasonably-sized tables intended to be read by a human can be generated within a millisecond.
438+
The table below provide some benchmark results, evaluating the performance on data containing incrementally larger number of `columns`, `rows`, and characters in each table cell (i.e. `cell_size`). You can benchmark it on your own system using the script contained within `py_markdown_table/utils/benchmark.py`. Generally, reasonably-sized tables intended to be read by a human can be generated within a millisecond.
439439

440440
<details>
441441
<summary >

0 commit comments

Comments
 (0)