UUDigitalHumanitieslab · JeltevanBoheemen · Aug 7, 2023 · Jun 7, 2023 · Jun 7, 2023 · Jun 7, 2023
diff --git a/.flake8 b/.flake8
@@ -1,2 +1,16 @@
 [flake8]
-ignore = E501, W503, E704, F841, E265
+ignore = 
+    # Line too long
+    E501
+    # Multiple statements on one line
+    E704
+    # Block comment should start with hash 
+    E265
+    # Local variable name is assigned to but never used 
+    F841
+    # Line break occurs before binary operator (deprecated)
+    W503
+exclude =
+    __pycache__
+    env
+    .env
diff --git a/.gitignore b/.gitignore
@@ -14,6 +14,7 @@ pip-delete-this-directory.txt
 coverage.xml
 *.cover
 .pytest_cache/
+.mypy_cache/
 
 # Environments
 .env
@@ -25,7 +26,7 @@ env.bak/
 venv.bak/
 
 # configuration
-./config.py
+config.py
 
 # additional files
 .idea/
@@ -36,5 +37,18 @@ sastalog.txt
 # documentation
 Documentation/_build/
 
-
+# Distribution / packaging
+bin/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
 
diff --git a/README.md b/README.md
@@ -6,14 +6,106 @@
 
 Method definitions for use in SASTA
 
-Copy `default_config.py` to your own `config.py` in the `sastadev` directory, and change what you need.
+## Installation
+You can install SASTADEV using pip:
+```
+pip install sastadev
+```
+
+## Usage
+
+### Command line interface
+The installation provides an entrypoint `sastadev` which invokes `sastadev.__main__.main()`
+
+To lists arguments and options:
+
+```
+sastadev -h
+```
+or
+```
+python -m sastadev -h
+```
+
+### Using as a library
+```python
+from sastadev.deregularise import correctinflection
+result = correctinflection('slaapten')
+print(result)
+# [('sliepen', 'Overgeneralisation')]
+```
+
+## Configuration
+The package contains a configuration module `sastadev.conf` that produces a `SastadevConfig` object at runtime, called `settings`.
+
+### Using settings values
+Example 1 (**correct**): 
+```python
+from sastadev.conf import settings
+def get_dataroot():
+    print(settings.DATAROOT)
+```
+
+Example 2 (**wrong!**):
+```python
+from sastadev.conf import settings
+
+dataroot = settings.DATAROOT
+
+def get_dataroot():
+    print(dataroot)
+```
+
+The key difference is that the code in example 2 evaluates `settings.DATAROOT` at the moment the code is executed. If `settings.DATAROOT` changes between the first time the module is loaded and the time it is ran, the first value will be used. This disables configurable settings.
+
+
+### Changing settings
+`sastadev.conf.settings` can be changed at runtime. 
+> :warning: **Changing `settings` properties changes _all_ code that is executed after the change**. Therefore, make sure you set the settings **once**, and at the beginning of the runtime cycle.  
+
+## Development
+To install the requirements:
+```
+pip install -r requirements.txt
+```
+
+### Installing locally
+To install the package in editable state:
+```
+pip install -e .
+```
 
-## Upload to PyPi
+### Testing
+Tests should be written and run using [pytest](https://docs.pytest.org/).
+To test, make sure the package is installed in editable mode.
+Then, each time you wish to run the tests:
+```
+pytest
+```
+
+### Linting
+Linting configuration is provided for [flake8](https://flake8.pycqa.org/en/latest/).
+To lint, run:
+```
+flake8 ./src/sastadev/
+```
+
+### Upload to PyPi
 
 Specify the files which should be included in the package in `pypi/include.txt`.
 
 ```bash
-cd pypi
-./prepare.sh
-twine upload dist/*
+pip install twine
+python setup.py sdist
+twine upload dist/*.tar.gz
 ```
+
+## Contributing
+Enhancements, bugfixes, and new features are welcome. For major changes, please follow these steps:
+
+- open an issue to discuss what you would like to change
+- create a branch `feature/<your-branchname`>, based on `develop` that contains your changes 
+- ensure the code is well tested
+- create a pull request for merging the changes into `develop`
+- the maintainers will take care of reviewing the code, offering suggested changes, and merging the code
+- at the discretion of the maintainers, the `develop` branch will be merged into `master`, and a new release will be made
diff --git a/__init__.py b/__init__.py
diff --git a/apps.py b/apps.py
diff --git a/celexlexicondata/__init__.py b/celexlexicondata/__init__.py
diff --git a/celexlexicondata/dutch/__init__.py b/celexlexicondata/dutch/__init__.py
diff --git a/dataconfig.py b/dataconfig.py
diff --git a/default_config.py b/default_config.py
diff --git a/Documentation/Makefile → docs/Makefile b/Documentation/Makefile → docs/Makefile
diff --git a/Documentation/Tarsp.rst → docs/Tarsp.rst b/Documentation/Tarsp.rst → docs/Tarsp.rst
diff --git a/Documentation/alpinoparser.rst → docs/alpinoparser.rst b/Documentation/alpinoparser.rst → docs/alpinoparser.rst
diff --git a/Documentation/asta.rst → docs/asta.rst b/Documentation/asta.rst → docs/asta.rst
diff --git a/Documentation/auxiliarymodules.rst → docs/auxiliarymodules.rst b/Documentation/auxiliarymodules.rst → docs/auxiliarymodules.rst
diff --git a/Documentation/chatannotations.rst → docs/chatannotations.rst b/Documentation/chatannotations.rst → docs/chatannotations.rst
diff --git a/Documentation/conf.py → docs/conf.py b/Documentation/conf.py → docs/conf.py
diff --git a/Documentation/deviantlanguage.rst → docs/deviantlanguage.rst b/Documentation/deviantlanguage.rst → docs/deviantlanguage.rst
diff --git a/Documentation/index.rst → docs/index.rst b/Documentation/index.rst → docs/index.rst
diff --git a/Documentation/introduction.rst → docs/introduction.rst b/Documentation/introduction.rst → docs/introduction.rst
diff --git a/Documentation/lexicons.rst → docs/lexicons.rst b/Documentation/lexicons.rst → docs/lexicons.rst
diff --git a/Documentation/make.bat → docs/make.bat b/Documentation/make.bat → docs/make.bat
diff --git a/Documentation/methodimplementation.rst → docs/methodimplementation.rst b/Documentation/methodimplementation.rst → docs/methodimplementation.rst
diff --git a/Documentation/methods.rst → docs/methods.rst b/Documentation/methods.rst → docs/methods.rst
diff --git a/Documentation/references.rst → docs/references.rst b/Documentation/references.rst → docs/references.rst
diff --git a/Documentation/sastaanddev.rst → docs/sastaanddev.rst b/Documentation/sastaanddev.rst → docs/sastaanddev.rst
diff --git a/Documentation/smallclausetable.csv → docs/smallclausetable.csv b/Documentation/smallclausetable.csv → docs/smallclausetable.csv
diff --git a/Documentation/stap.rst → docs/stap.rst b/Documentation/stap.rst → docs/stap.rst
diff --git a/generatemacros.py b/generatemacros.py
diff --git a/mymypy.bat b/mymypy.bat
diff --git a/mypy.ini b/mypy.ini
diff --git a/pypi/.gitignore b/pypi/.gitignore
diff --git a/pypi/MANIFEST.in b/pypi/MANIFEST.in