Apply precommit

.github/workflows/docs.yaml

@@ -24,4 +24,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           CONFIG_FILE: docs/mkdocs.yml
-          REQUIREMENTS: docs/site_assets/requirements.txt
+          REQUIREMENTS: docs/site_assets/requirements.txt

.pre-commit-config.yaml

@@ -11,4 +11,4 @@ repos:
   - repo: https://github.com/prettier/pre-commit
     rev: v2.1.2
     hooks:
-      - id: prettier
+      - id: prettier

README.md

@@ -1,15 +1,17 @@
 # nlp-link
-A python package to semantically link two lists of texts.
 
+A python package to semantically link two lists of texts.
 
 ## Set-up
 
 In setting up this project we ran:
+
 ```
 conda create --name nlp-link pip python=3.9
 conda activate nlp-link
 pip install poetry
-pip install pre-commit
+pip install pre-commit black
+pre-commit install
 ```
 
 ```
@@ -38,6 +40,6 @@ However, if you are editing the docs you can test them out locally by running
 
 ```
 cd guidelines
-pip install -r docs/requirements.txt  
+pip install -r docs/requirements.txt
 mkdocs serve
 ```

docs/README.md

@@ -2,4 +2,4 @@
 
 Documentation for NLP Link
 
-- [Page1](./page1.md)
+- [Page1](./page1.md)

docs/mkdocs.yaml

@@ -41,4 +41,4 @@ nav:
   - Home: README.md
   - Page 1: page1.md
 plugins:
-  - same-dir
+  - same-dir

docs/page1.md

@@ -1 +1 @@
-## Title
+## Title

docs/site_assets/style.css

@@ -1,10 +1,10 @@
-@import url('https://fonts.cdnfonts.com/css/century-gothic');
+@import url("https://fonts.cdnfonts.com/css/century-gothic");
 html,
 body,
 [class*="css"] {
   font-family: "Century Gothic";
 }
 :root {
-  --md-primary-fg-color: #18A48C;
-  --md-accent-fg-color: #EB003B;
-}
+  --md-primary-fg-color: #18a48c;
+  --md-accent-fg-color: #eb003b;
+}

nlp_link/linker.py

@@ -1,11 +1,12 @@
 import pandas as pd
 import random
 
+
 def link_lists(list_1, list_2):
-	"""
-	Mock linker
-	"""
-	list_1_index = list(range(len(list_1)))
-	list_2_index = list(range(len(list_2)))
+    """
+    Mock linker
+    """
+    list_1_index = list(range(len(list_1)))
+    list_2_index = list(range(len(list_2)))
 
-	return [(i, random.choice(list_1_index)) for i in list_2_index]
+    return [(i, random.choice(list_1_index)) for i in list_2_index]

tests/test_linker.py

@@ -1,10 +1,10 @@
 from nlp_link.linker import link_lists
 
-def test_link_lists():
 
-	list_1 = ["dog", "cat"]
-	list_2 = ["kitten", "puppy"]
-	linked = link_lists(list_1, list_2)
+def test_link_lists():
 
-	assert len(linked) == len(list_1)
+    list_1 = ["dog", "cat"]
+    list_2 = ["kitten", "puppy"]
+    linked = link_lists(list_1, list_2)
 
+    assert len(linked) == len(list_1)