Metadata-Version: 2.1
Name: dynamicfluency
Version: 0.1.1
Summary: The base python package for DynamicFluency: Monitor and understand the dynamicity of linguistic aspects in (L2) speech.
Author-email: JJWRoeloffs <jelleroeloffs@gmail.com>
Project-URL: Homepage, https://github.com/JJWRoeloffs/bare_python_publish
Project-URL: Bug Tracker, https://github.com/JJWRoeloffs/bare_python_publish/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: praatio (==5.1)
Requires-Dist: nltk (==3.7)
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: typing-extensions
Requires-Dist: python-dateutil
Requires-Dist: joblib
Requires-Dist: click
Requires-Dist: regex
Requires-Dist: tqdm
Requires-Dist: pytz
Requires-Dist: six

# DynamicFluency-core

The base python package for DynamicFluency: track a l2 speaker's ability trough time. 

This package is effectivly a wrapper around a meriad of other projects to allow for smooth intergration

## Code style

For code formatting, [Black](https://github.com/psf/black) is used with default settings. Some of the naming from [praatio](https://github.com/timmahrt/praatIO) (e.g. `entryList`) is taken over, but, generally, `snake_case` is used for everything but classes, which are in `PascalCase`, as is python convention.

Also, I, (JJWRoeloffs,) am dyslectic, so there might be some spelling errors in the variable names and docstrings. If you find some, pull requests are welcome!

## Tests

Running the development tests can be done with the following command:
```
pytest --cov=dynamicfluency tests/
```
Please note that this requires pytest and pytest-cov to be installed. Additionally, `dynamicfluency` has to be installed, either with `pip install -e .` or trough other means if you want to compare versions. The code itself, as it is in `src/`, isn't recognised.  
