Merge pull request WikiTeam#8 from elsiehupp/pre-commit

Set up Git pre-commit

.pre-commit-config.yaml

@@ -0,0 +1,60 @@
+# Apply to all files without commiting:
+#   pre-commit run --all-files
+# Update this file:
+#   pre-commit autoupdate
+default_language_version:
+    python: python3.8
+repos:
+-   repo: https://github.com/python-poetry/poetry
+    rev: 1.2.0b1
+    hooks:
+    -   id: poetry-check
+    # -   id: poetry-lock
+    -   id: poetry-export
+        args: ["-f", "requirements.txt", "-o", "requirements.txt"]
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+    -   id: check-ast
+    -   id: check-byte-order-marker
+    -   id: check-case-conflict
+    -   id: check-docstring-first
+    -   id: check-executables-have-shebangs
+    -   id: check-json
+    -   id: check-yaml
+    -   id: debug-statements
+    # -   id: detect-aws-credentials
+    # -   id: detect-private-key
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: mixed-line-ending
+# -   repo: https://github.com/pre-commit/mirrors-mypy
+#     rev: v0.942
+#     hooks:
+#     -   id: mypy
+#         args: [--ignore-missing-imports]
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+    -   id: isort
+        args: ["--profile", "black", "--filter-files"]
+-   repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.1
+    hooks:
+    -   id: pyupgrade
+        args: [--py38-plus]
+-   repo: https://github.com/asottile/blacken-docs
+    rev: v1.12.1
+    hooks:
+    -   id: blacken-docs
+        additional_dependencies: [black==20.8b1]
+### Needs argument for diasabling line_length
+### https://github.com/jackdewinter/pymarkdown/blob/main/docs/rules/rule_md013.md
+# -   repo: https://github.com/jackdewinter/pymarkdown
+#     rev: v0.9.5
+#     hooks:
+#     -   id: pymarkdown

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.linting.flake8Args": [
+        "--ignore=E501",
+        "--max-line-length=120"
+    ],
+    "python.linting.flake8Enabled": true
+}

README.md

@@ -1,25 +1,27 @@
 # WikiTeam
-### We archive wikis, from Wikipedia to tiniest wikis
+
+## We archive wikis, from Wikipedia to tiniest wikis
 
 **WikiTeam software is a set of tools for archiving wikis.** They work on MediaWiki wikis, but we want to expand to other wiki engines. As of 2020, WikiTeam has preserved more than [250,000 wikis](https://github.com/WikiTeam/wikiteam/wiki/Available-Backups), several wikifarms, regular Wikipedia dumps and [34 TB of Wikimedia Commons images](https://archive.org/details/wikimediacommons).
 
 There are [thousands](http://wikiindex.org) of [wikis](https://wikiapiary.com) in the Internet. Every day some of them are no longer publicly available and, due to lack of backups, lost forever. Millions of people download tons of media files (movies, music, books, etc) from the Internet, serving as a kind of distributed backup. Wikis, most of them under free licenses, disappear from time to time because nobody grabbed a copy of them. That is a shame that we would like to solve.
 
 **WikiTeam** is the [Archive Team](http://www.archiveteam.org) ([GitHub](https://github.com/ArchiveTeam)) subcommittee on wikis. It was founded and originally developed by [Emilio J. Rodríguez-Posada](https://github.com/emijrp), a Wikipedia veteran editor and amateur archivist. Many people have helped by sending suggestions, [reporting bugs](https://github.com/WikiTeam/wikiteam/issues), writing [documentation](https://github.com/WikiTeam/wikiteam/wiki), providing help in the [mailing list](http://groups.google.com/group/wikiteam-discuss) and making [wiki backups](https://github.com/WikiTeam/wikiteam/wiki/Available-Backups). Thanks to all, especially to: [Federico Leva](https://github.com/nemobis), [Alex Buie](https://github.com/ab2525), [Scott Boyd](http://www.sdboyd56.com), [Hydriz](https://github.com/Hydriz), Platonides, Ian McEwen, [Mike Dupont](https://github.com/h4ck3rm1k3), [balr0g](https://github.com/balr0g) and [PiRSquared17](https://github.com/PiRSquared17).
 
-<table border=0 cellpadding=5px>
-<tr><td>
-<a href="https://github.com/WikiTeam/wikiteam/wiki/Tutorial"><img src="https://upload.wikimedia.org/wikipedia/commons/f/f3/Nuvola_apps_Wild.png" width=100px alt="Documentation" title="Documentation"/></a>
-</td><td>
-<a href="https://raw.githubusercontent.com/WikiTeam/wikiteam/master/dumpgenerator.py"><img src="http://upload.wikimedia.org/wikipedia/commons/2/2a/Nuvola_apps_kservices.png" width=100px alt="Source code" title="Source code"/></a>
-</td><td>
-<a href="https://github.com/WikiTeam/wikiteam/wiki/Available-Backups"><img src="https://upload.wikimedia.org/wikipedia/commons/3/37/Nuvola_devices_3floppy_mount.png" width=100px alt="Download available backups" title="Download available backups"/></a>
-</td><td>
-<a href="https://groups.google.com/group/wikiteam-discuss"><img src="https://upload.wikimedia.org/wikipedia/commons/0/0f/Nuvola_apps_kuser.png" width=100px alt="Community" title="Community"/></a>
-</td><td>
-<a href="https://twitter.com/_WikiTeam"><img src="https://upload.wikimedia.org/wikipedia/commons/e/eb/Twitter_logo_initial.png" width=90px alt="Follow us on Twitter" title="Follow us on Twitter"/></a>
-</td></tr>
-</table>
+![Documentation](https://upload.wikimedia.org/wikipedia/commons/f/f3/Nuvola_apps_Wild.png)
+[Documentation](https://github.com/WikiTeam/wikiteam/wiki/Tutorial)
+
+![Source code](http://upload.wikimedia.org/wikipedia/commons/2/2a/Nuvola_apps_kservices.png)
+[Source code](https://raw.githubusercontent.com/WikiTeam/wikiteam/master/dumpgenerator.py)
+
+![Download available backups](https://upload.wikimedia.org/wikipedia/commons/3/37/Nuvola_devices_3floppy_mount.png)
+[Download available backups](https://github.com/WikiTeam/wikiteam/wiki/Available-Backups)
+
+![Community](https://upload.wikimedia.org/wikipedia/commons/0/0f/Nuvola_apps_kuser.png)
+[Community](https://groups.google.com/group/wikiteam-discuss)
+
+![Follow us on Twitter](https://upload.wikimedia.org/wikipedia/commons/e/eb/Twitter_logo_initial.png)
+[Follow us on Twitter](https://twitter.com/_WikiTeam)
 
 ## Quick guide
 
@@ -29,7 +31,7 @@ These instructions assume you will run WikiTeam from a cloned or downloaded copy
 
 ### Requirements
 
-Requires <a href="https://www.python.org/downloads/release/python-380/">Python 3.8</a> or later (less than 4.0).
+Requires [Python 3.8](https://www.python.org/downloads/release/python-380/) or later (less than 4.0).
 
 Confirm you satisfy the requirements:
 

docs/README.md

@@ -1,3 +1,3 @@
-Read WikiTeam docs in http://wikiteam.readthedocs.io
+# Read WikiTeam docs in <http://wikiteam.readthedocs.io>
 
-Tutorial for Sphinx http://www.sphinx-doc.org/en/stable/tutorial.html
+Tutorial for Sphinx <http://www.sphinx-doc.org/en/stable/tutorial.html>

docs/_build/html/_sources/index.txt

@@ -20,4 +20,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

docs/_build/html/_static/alabaster.css

@@ -690,4 +690,4 @@ table.docutils.citation, table.docutils.citation td, table.docutils.citation th
   -moz-box-shadow: none;
   -webkit-box-shadow: none;
   box-shadow: none;
-}
+}

docs/_build/html/_static/basic.css

@@ -601,4 +601,4 @@ span.eqno {
     #top-link {
         display: none;
     }
-}
+}

docs/_build/html/_static/classic.css

@@ -258,4 +258,4 @@ div.viewcode-block:target {
 div.code-block-caption {
     color: #efefef;
     background-color: #1c4e63;
-}
+}

docs/_build/html/_static/doctools.js

@@ -124,7 +124,7 @@ var Documentation = {
     this.fixFirefoxAnchorBug();
     this.highlightSearchWords();
     this.initIndexTable();
-    
+
   },
 
   /**
@@ -284,4 +284,4 @@ _ = Documentation.gettext;
 
 $(document).ready(function() {
   Documentation.init();
-});
+});

docs/_build/html/_static/pygments.css

@@ -62,4 +62,4 @@
 .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
 .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
 .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
-.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
+.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */

docs/_build/html/_static/searchtools.js

@@ -10,7 +10,7 @@
  */
 
 
-/* Non-minified version JS is _stemmer.js if file is provided */ 
+/* Non-minified version JS is _stemmer.js if file is provided */
 /**
  * Porter Stemmer
  */
@@ -648,4 +648,4 @@ var Search = {
 
 $(document).ready(function() {
   Search.init();
-});
+});

docs/_build/html/_static/sidebar.js

@@ -22,13 +22,13 @@
  */
 
 $(function() {
-  
-  
-  
-  
-  
-  
-  
+
+
+
+
+
+
+
 
   // global elements used by the functions.
   // the 'sidebarbutton' element is defined as global after its
@@ -156,4 +156,4 @@ $(function() {
   add_sidebar_button();
   var sidebarbutton = $('#sidebarbutton');
   set_position_from_cookie();
-});
+});