added pypi package prerequisites

cvjena · Aug 28, 2024 · 381224a · 381224a
1 parent 52487c8
commit 381224a
Show file tree

Hide file tree

Showing 14 changed files with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,6 @@
+# STYLOTOOL - an easy-to-use stylistic device detection tool for stylometry
+
+An easy-to-use package for detecting stylistic devices in text. This package is designed to be used in stylometry, the study of linguistic style.
+
+For those proficient in python, this package provides a collection of approaches to detect stylistic devices in text. For those less proficient in python, this package provides a simple interface to detect stylistic devices in text with simple commands and user-friendly configuration.
+For an example on usage, see `example_chiasmus.sh` and the config file `example_config.json`.
diff --git a/example_chiasmus.sh b/example_chiasmus.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
 
 mkdir -p example
-cd code
+cd src
 python3 stylotool.py --input ../datasets/tests/chiasmustest.txt --output ../example/chiasmus_results.json --config ../example_config.json
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,17 @@
+[project]
+name = "stylotool"
+version = "0.0.1"
+authors = [
+    { name = "Felix Schneider", email = "[email protected]"},
+]
+description = "A tool for stylistic device detection"
+readme = "README.md"
+requires-python = ">=3.6"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    ]
+
+[project.urls]
+Homepage = "https://github.com/cvjena/stylotool"
+Issues = "https://github.com/cvjena/stylotool/issues"
diff --git a/code/AlliterationAnnotation.py → src/AlliterationAnnotation.py b/code/AlliterationAnnotation.py → src/AlliterationAnnotation.py
diff --git a/code/ChiasmusAnnotation.py → src/ChiasmusAnnotation.py b/code/ChiasmusAnnotation.py → src/ChiasmusAnnotation.py
diff --git a/code/MGHPreprocessor.py → src/MGHPreprocessor.py b/code/MGHPreprocessor.py → src/MGHPreprocessor.py
diff --git a/code/TextObject.py → src/TextObject.py b/code/TextObject.py → src/TextObject.py
diff --git a/code/TextPreprocessor.py → src/TextPreprocessor.py b/code/TextPreprocessor.py → src/TextPreprocessor.py
diff --git a/code/stylotool.py → src/stylotool.py b/code/stylotool.py → src/stylotool.py
diff --git a/code/test/test_text.json → src/test/test_text.json b/code/test/test_text.json → src/test/test_text.json
diff --git a/code/test/test_text_de.json → src/test/test_text_de.json b/code/test/test_text_de.json → src/test/test_text_de.json
diff --git a/code/test_chiasmus_annotation.py → src/test_chiasmus_annotation.py b/code/test_chiasmus_annotation.py → src/test_chiasmus_annotation.py
diff --git a/code/test_text_object.py → src/test_text_object.py b/code/test_text_object.py → src/test_text_object.py
diff --git a/code/train_chiasmus_model.py → src/train_chiasmus_model.py b/code/train_chiasmus_model.py → src/train_chiasmus_model.py