Merge pull request #5 from sadikkuzu/enhancement/pre-commit

Add pre-commit config

.gitignore

@@ -379,4 +379,3 @@ $RECYCLE.BIN/
 # End of https://www.toptal.com/developers/gitignore/api/windows,visualstudiocode,linux,macos,pycharm+all,python,sublimetext,vim,vscode
 
 # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
-

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: check-ast
+    -   id: check-docstring-first
+    -   id: check-merge-conflict
+    -   id: check-toml
+-   repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v1.17.0
+    hooks:
+    -   id: setup-cfg-fmt
+-   repo: https://github.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+    -   id: flake8
+-   repo: https://github.com/asottile/add-trailing-comma
+    rev: v2.1.0
+    hooks:
+    -   id: add-trailing-comma
+        args: [--py36-plus]

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,7 +1,8 @@
 # squiral
-![](https://img.shields.io/pypi/v/squiral) 
-[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) 
-![]( https://img.shields.io/pypi/pyversions/squiral.svg )
+[![](https://img.shields.io/pypi/v/squiral)](https://pypi.org/project/squiral/)
+[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
+[![](https://img.shields.io/pypi/pyversions/squiral.svg)](https://pypi.org/project/squiral/)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sadikkuzu/squiral/main.svg)](https://results.pre-commit.ci/latest/github/sadikkuzu/squiral/main)
 
 **squ**are sp**iral**
 
@@ -17,12 +18,12 @@ Here is an example:
 
 The basic idea behind printing this matrix is<br/>
 to start from the middle of the matrix and then moving:<br/>
-```right```>> ```down```>>``` left```>>``` up```<br/>
+`right` >> `down` >> `left` >> `up`<br/>
 and not returning to the same row again.
 
 ### Install
 
-````pip install squiral````
+`pip install squiral`
 
 #### Usage
 

pyproject.toml

@@ -3,6 +3,7 @@ name = "squiral"
 version = "0.1.2"
 description = "squiral - square spiral"
 authors = ["SADIK KUZU <[email protected]>"]
+homepage = "https://github.com/sadikkuzu/squiral"
 readme = "README.md"
 license = "MIT"
 

squiral/__init__.py

@@ -2,11 +2,11 @@
 
 from .squiral import (
     produce,
-    printout
+    printout,
 )
 
 __all__ = [
     '__version__',
     'produce',
-    'printout'
-    ]
+    'printout',
+]