Merge pull request #221 from KennethEnevoldsen/review-update

updated docs based on review

.github/workflows/tests.yml

@@ -41,7 +41,6 @@ jobs:
         shell: bash
         run: |
           make install
-          pip install -r tests/requirements.txt
 
       - name: Run tests
         shell: bash

CONTRIBUTING.md

@@ -42,7 +42,7 @@ $ make install
 ```
 
 
-## How to test the project
+### How to test the project
 
 Run the full test suite:
 

docs/conf.py

@@ -112,4 +112,3 @@
     "sidebar_hide_name": True,
     "navigation_with_keys": True,
 }
-

makefile

@@ -1,6 +1,7 @@
 install:
 	@echo "--- 🚀 Installing project ---"
 	pip install -e ".[dev, docs, tests,tutorials,all,da]" 
+	pip install -r tests/requirements.txt
 
 static-type-check:
 	@echo "--- 🔍 Running static type check ---"
@@ -11,7 +12,7 @@ lint:
 	@echo "--- 🧹 Running linters ---"
 	pyproject-parser check pyproject.toml 		# check pyproject.toml
 	ruff format .  								# running ruff formatting (.ipynb, .py)
-	ruff **/*.py --fix  						# running ruff linting (.py)
+	ruff check **/*.py --fix  					# running ruff linting (.py)
 
 test:
 	@echo "--- 🧪 Running tests ---"

paper/paper.md

@@ -37,7 +37,6 @@ Other tools for data augmentation focus on specific downstream application such
 
 
 # Features & Functionality
-
 `Augmenty` is a Python library that implements augmentations based on `spaCy`'s `Doc` object. `spaCy`'s `Doc` object is a container for a text and its annotations. This makes it easy to augment text and annotations simultaneously. The `Doc` object can easily be extended to include custom augmentation not available in `spaCy` by adding custom attributes to the `Doc` object. While `Augmenty` is built to augment `Doc`s the object is easily converted into strings, lists or other formats. The annotations within a `Doc` can be provided either by human annotations or using a trained model.
 
 Augmenty implements a series of augmenters for token-, span- and sentence-level augmentation. These augmenters range from primitive augmentations such as word replacement to language specific augmenters such as keystroke error augmentations based on a French keyboard layout. Augmenty also integrates with other libraries such as `NLTK` [@bird2009natural] to allow for augmentations based on WordNet [@miller-1994-wordnet] and allows for specification of static word vectors [pennington-etal-2014-glove] to allow for augmentations based on word similarity. Lastly, `augmenty` provides a set of utility functions for repeating augmentations, combining augmenters or adjust the percentage of documents that should be augmented. This allow for the flexible construction of augmentation pipelines specific to the task at hand.

pyproject.toml

@@ -69,7 +69,7 @@ dev = [
     "pyproject-parser[cli, readme]>=0.9.1",
 ]
 tests = [
-    "pytest>=7.1.3",
+    "pytest>=7.1.3,<8.0.0",       # due to https://github.com/TvoroG/pytest-lazy-fixture/issues/65
     "pytest-cov>=3.0.0",
     "pytest-lazy-fixture>=0.6.3",
     "pytest-timeout>=2.1.0",
@@ -92,7 +92,7 @@ pythonPlatform = "Darwin"
 [tool.ruff]
 extend-include = ["*.ipynb"]
 # Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
-select = [
+lint.select = [
     "A",
     "ANN",
     "ARG",
@@ -120,7 +120,7 @@ select = [
     "SIM",
     "W",
 ]
-ignore = [
+lint.ignore = [
     "ANN101",
     "ANN401",
     "E402",
@@ -130,9 +130,9 @@ ignore = [
     "RET504",
     "COM812",
 ]
-ignore-init-module-imports = true
+lint.ignore-init-module-imports = true
 # Allow autofix for all enabled rules (when `--fix`) is provided.
-unfixable = ["ERA"]
+lint.unfixable = ["ERA"]
 # Exclude a variety of commonly ignored directories.
 exclude = [
     ".bzr",
@@ -158,10 +158,10 @@ exclude = [
     "docs/conf.py",
 ]
 # Allow unused variables when underscore-prefixed.
-dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 target-version = "py38"
 
-[tool.ruff.flake8-annotations]
+[tool.ruff.lint.flake8-annotations]
 mypy-init-return = true
 suppress-none-returning = true
 

readme.md

@@ -26,7 +26,7 @@ pip install augmenty
 Do note that this is a minimal installation. As some augmenters requires additional packages please write the following line to install all dependencies.
 
 ```
-pip install augmenty[all]
+pip install "augmenty[all]"
 ```
 
 For more detailed instructions on installing augmenty, including specific language support, see the [installation instructions](https://kennethenevoldsen.github.io/augmenty/installation).
@@ -39,6 +39,7 @@ import spacy
 import augmenty
 
 nlp = spacy.load("en_core_web_md")
+# if not installed run: python -m spacy download en_core_web_md
 
 docs = nlp.pipe(["Augmenty is a great tool for text augmentation"])
 

src/augmenty/character/replace.py

@@ -1,6 +1,5 @@
 """Augmenters for randomly or semi-randomly replacing characters."""
 
-
 import random
 from functools import partial
 from typing import Callable, Iterator

src/augmenty/character/swap.py

@@ -1,6 +1,5 @@
 """Augmenters for swapping characters."""
 
-
 import random
 from functools import partial
 from typing import Callable, Iterator

src/augmenty/keyboard.py

@@ -1,4 +1,5 @@
 """Function for defining and handling keyboard layouts."""
+
 from typing import Dict, List, Tuple
 
 from pydantic import BaseModel

tests/test_all_augmenters.py

@@ -1,6 +1,5 @@
 """Pytest script for testing all augmenters in a variety of cases."""
 
-
 from typing import Iterable
 
 import augmenty