Merge pull request #5 from tmsincomb/docs

removed unused code; fixed readme bugs; cleared flake errors
tmsincomb · Jun 20, 2023 · 9bfaecf · 9bfaecf
2 parents e3a0e21 + 073af80
commit 9bfaecf
Show file tree

Hide file tree

Showing 33 changed files with 98 additions and 709 deletions.
diff --git a/.editorconfig b/.editorconfig
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.3.0
+    rev: v4.0.1
     hooks:
       - id: check-yaml
         args: ["--unsafe"]
@@ -11,10 +11,9 @@ repos:
     rev: 22.10.0
     hooks:
       - id: black
-        files: "(src|tests).*py"
         args: ["-l", "120"]
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
         name: isort (python)

diff --git a/.travis.yml b/.travis.yml
diff --git a/AUTHORS.rst b/AUTHORS.rst
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
diff --git a/HISTORY.rst b/HISTORY.rst
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -31,9 +31,9 @@
 
 <p align="center" style="color:green">
   <a href="#about">About</a> •
-  <a href="#macos-install">Install</a> •
-  <a href="#terminal-usage">Terminal</a> •
-  <a href="#python-simple-usage">Python</a> •
+  <a href="#installation">Install</a> •
+  <a href="#terminal">Terminal</a> •
+  <a href="#python">Python</a> •
   <a href="#license">License</a>
 </p>
 
@@ -71,7 +71,8 @@ sudo apt install --yes build-essential libpoppler-cpp-dev pkg-config tesseract-o
 # Installation
 
 ```bash
-conda install -c conda-forge tesseract==5.2.0 poppler==22.11.0
+conda create -n imagetocsv -f environment.yml
+conda activate imagetocsv
 pip install imagetocsv
 ```
 
@@ -82,6 +83,7 @@ pip install imagetocsv
 ```bash
 conda create -n imagetocsv -f environment.yml
 conda activate imagetocsv
+pip install -e ".[dev]"
 ```
 
 ## Testing

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/authors.rst b/docs/authors.rst