Skip to content

Commit 504594b

Browse files
mr-mixasmr-mixas
committed
add .gitignore and pre-commit, cosmetics
1 parent fc348de commit 504594b

File tree

4 files changed

+168
-3
lines changed

4 files changed

+168
-3
lines changed

‎.gitignore‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
131+
.idea/*
132+
133+
*.swp

‎.pre-commit-config.yaml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
repos:
3+
- repo: https://github.com/pre-commit/pre-commit-hooks
4+
hooks:
5+
- id: check-added-large-files
6+
- id: check-case-conflict
7+
- id: check-json
8+
- id: check-shebang-scripts-are-executable
9+
- id: check-symlinks
10+
- id: check-toml
11+
- id: check-vcs-permalinks
12+
- id: check-yaml
13+
- id: double-quote-string-fixer
14+
rev: v4.5.0
15+
16+
- repo: https://github.com/crate-ci/typos
17+
hooks:
18+
- id: typos
19+
rev: v1.19.0
20+
21+
- repo: https://github.com/jackdewinter/pymarkdown
22+
hooks:
23+
- id: pymarkdown
24+
rev: v0.9.18
25+
26+
- repo: https://github.com/rhysd/actionlint
27+
hooks:
28+
- id: actionlint
29+
rev: v1.6.27

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,19 @@ REST API and web UI for [Nested-Diff.py](https://github.com/mr-mixas/Nested-Diff
55
**[Live Demo](https://nesteddiff.pythonanywhere.com/)**
66

77
## Install
8+
89
```sh
910
pip install nested_diff_restful
1011
```
1112

1213
## Run
14+
1315
```sh
1416
nested_diff_restful --bind 127.0.0.1:8080 --workers=4
1517
```
1618

1719
## Run tests
20+
1821
```sh
1922
pip install -e .[test]
2023
pytest

‎nested_diff_restful/templates/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!doctype html>
22
<html lang="en">
33
<head>
4+
<title>Nested-Diff</title>
45
<meta charset="utf-8">
56
<meta name="description" content="Nested-Diff web UI">
67
<meta name="keywords" content="nested-diff,nested-diff-restful,recursive-diff">
78
<meta name="viewport" content="width=device-width, initial-scale=1">
8-
<title>Nested-Diff</title>
9-
<link rel="icon" href="/static/favicon.svg" type="image/svg+xml">
9+
<link href="/static/favicon.svg" rel="icon" type="image/svg+xml">
1010
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet">
1111
<link href="/api/v1/nested_diff.css" rel="stylesheet">
1212
<script src="https://cdn.jsdelivr.net/npm/jquery@3.7.1/dist/jquery.min.js"></script>
@@ -27,7 +27,7 @@
2727
<div class="container">
2828
<form>
2929
<h1><a href="https://github.com/mr-mixas/Nested-Diff.py">Nested-Diff</a></h1>
30-
<div class="input-group mb-3" id="dif-input">
30+
<div class="input-group mb-3">
3131
<span class="input-group-text">A:</span>
3232
<textarea class="form-control font-monospace" id="dif-a" rows="5">[0, 1, 2, "multi\nline"]</textarea>
3333
<span class="input-group-text">B:</span>

0 commit comments

Comments
 (0)