Merge branch 'release/0.5.9'

CITATION.cff

@@ -0,0 +1,25 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: CHAMD
+message: Please cite this software using these metadata.
+type: software
+authors:
+  - given-names: Jan
+    family-names: Odijk
+    affiliation: Utrecht University
+    email: j.odijk@uu.nl
+  - given-names: Sheean
+    family-names: Spoel
+    email: s.j.j.spoel@uu.nl
+    affiliation: Utrecht University
+  - given-names: Jelte
+    family-names: van Boheemen
+    email: j.vanboheemen@uu.nl
+    affiliation: Utrecht University
+repository-code: 'https://github.com/UUDigitalHumanitieslab/chamd'
+abstract: >-
+  Conversion and cleaning of CHILDES CHA files into PaQu
+  Plaintext Metadata Format (to convert to Alpino).
+license: MIT

README.md

@@ -0,0 +1,45 @@
+[![Python package](https://github.com/UUDigitalHumanitieslab/chamd/actions/workflows/python-package.yml/badge.svg?branch=develop)](https://github.com/UUDigitalHumanitieslab/chamd/actions/workflows/python-package.yml)
+
+[![Python package](https://badge.fury.io/py/chamd.svg)](https://pypi.python.org/pypi/chamd/)
+
+# CHAMD
+Conversion and cleaning of CHILDES CHA files into PaQu Plaintext
+Metadata Format (to convert to Alpino).
+
+## Installation and usage
+```bash
+pip install chamd
+chamd --help
+```
+
+Running from project:
+```bash
+python -m chamd --help
+```
+
+## Import as library
+This way the library can be used to read CHAT file (contents) from an external application.
+
+```python
+from chamd import ChatReader
+reader = ChatReader()
+chat = reader.read_file('example.cha') # or read_string
+
+for item in chat.metadata:
+    print(item)
+for line in chat.lines:
+    for item in line.metadata:
+        print(item)
+    print(line.text)
+```
+
+## Upload to PyPi
+```bash
+python setup.py sdist
+twine upload dist/*
+```
+
+## Run tests
+```bash
+python -m unittest discover tests/
+```

setup.py

@@ -6,7 +6,7 @@
 setup(
     name='chamd',
     python_requires='>=3.5, <4',
-    version='0.5.8',
+    version='0.5.9',
     description='Conversion and cleaning of CHILDES CHA files into PaQu Plaintext Metadata Format',
     long_description=long_description,
     author='Digital Humanities Lab, Utrecht University',