Metadata-Version: 2.1
Name: pylangacq
Version: 0.16.0
Summary: Language Acquisition Research in Python
Home-page: https://pylangacq.org/
Author: Jackson L. Lee
Author-email: jacksonlunlee@gmail.com
License: MIT License
Download-URL: https://pypi.org/project/pylangacq/#files
Project-URL: Source, https://github.com/jacksonllee/pylangacq
Project-URL: Tracker, https://github.com/jacksonllee/pylangacq/issues
Project-URL: Changelog, https://pylangacq.org/changelog.html
Keywords: computational linguistics,natural language processing,NLP,linguistics,corpora,speech,language,CHILDES,CHAT,transcription,acquisition,development,learning
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Filters
Classifier: Topic :: Text Processing :: General
Classifier: Topic :: Text Processing :: Indexing
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE.txt

PyLangAcq: Language Acquisition Research in Python
==================================================

Full documentation: https://pylangacq.org

|

.. image:: https://badge.fury.io/py/pylangacq.svg
   :target: https://pypi.python.org/pypi/pylangacq
   :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/pylangacq.svg
   :target: https://pypi.python.org/pypi/pylangacq
   :alt: Supported Python versions

.. image:: https://circleci.com/gh/jacksonllee/pylangacq.svg?style=shield
   :target: https://circleci.com/gh/jacksonllee/pylangacq
   :alt: CircleCI Builds

|

.. start-sphinx-website-index-page

PyLangAcq is a Python library for language acquisition research.

- Easy access to CHILDES and other TalkBank datasets
- Intuitive Python data structures for flexible data access and manipulation
- Standard developmental measures readily available: Mean length of utterance (MLU),
  type-token ratio (TTR), and index of productive syntax (IPSyn)
- Direct support and powerful extensions possible for CHAT-formatted conversational datasets
  more generally

.. _download_install:

Download and Install
--------------------

To download and install the most recent version::

    $ pip install --upgrade pylangacq

Ready for more?
Check out the `Quickstart <https://pylangacq.org/quickstart.html>`_ page.

Consulting
----------

If your team would like professional assistance in using PyLangAcq,
freelance consulting and training services are available for both academic and commercial groups.
Please email `Jackson L. Lee <https://jacksonllee.com>`_.

Support
-------

If you have found PyLangAcq useful and would like to offer support,
`buying me a coffee <https://www.buymeacoffee.com/pylangacq>`_ would go a long way!

Links
-----

* Source code: https://github.com/jacksonllee/pylangacq
* Bug tracker: https://github.com/jacksonllee/pylangacq/issues
* Social media: `Twitter <https://twitter.com/pylangacq>`_

How to Cite
-----------

PyLangAcq is authored and maintained by `Jackson L. Lee <https://jacksonllee.com>`_.

Lee, Jackson L., Ross Burkholder, Gallagher B. Flinn, and Emily R. Coppess. 2016.
`Working with CHAT transcripts in Python <https://jacksonllee.com/papers/lee-etal-2016-pylangacq.pdf>`_.
Technical report `TR-2016-02 <https://newtraell.cs.uchicago.edu/research/publications/techreports/TR-2016-02>`_,
Department of Computer Science, University of Chicago.

.. code-block:: latex

    @TechReport{lee-et-al-pylangacq:2016,
       Title       = {Working with CHAT transcripts in Python},
       Author      = {Lee, Jackson L. and Burkholder, Ross and Flinn, Gallagher B. and Coppess, Emily R.},
       Institution = {Department of Computer Science, University of Chicago},
       Year        = {2016},
       Number      = {TR-2016-02},
    }

License
-------

MIT License. Please see ``LICENSE.txt`` in the GitHub source code for details.

The test data files included come from CHILDES,
and have a `CC BY-NC-SA 3.0 <https://creativecommons.org/licenses/by-nc-sa/3.0/>`_
license instead; please also see
``pylangacq/tests/test_data/README.md`` in the GitHub source code for details.

.. end-sphinx-website-index-page

Changelog
---------

Please see ``CHANGELOG.md``.

Setting up a Development Environment
------------------------------------

The latest code under development is available on Github at
`jacksonllee/pylangacq <https://github.com/jacksonllee/pylangacq>`_.
To obtain this version for experimental features or for development:

.. code-block:: bash

   $ git clone https://github.com/jacksonllee/pylangacq.git
   $ cd pylangacq
   $ pip install -r dev-requirements.txt
   $ pip install -e .

To run tests and styling checks:

.. code-block:: bash

   $ pytest -vv --doctest-modules --cov=pylangacq pylangacq docs/source
   $ flake8 pylangacq
   $ black --check pylangacq

To build the documentation website files:

.. code-block:: bash

    $ python docs/source/build_docs.py


