.. lingcorpora documentation master file, created by
   sphinx-quickstart on Tue Nov 27 20:48:13 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

lingcorpora: documentation
=======================================

This package includes API for more than 20 online text corpora. Comprehensive list of supported corpora is available below in the `Contents <#contents>`_ section.

R version of this package by George Moroz is located `here <https://github.com/lingcorpora/lingcorpora.R>`_.

| The package is available under `MIT license <https://github.com/lingcorpora/lingcorpora.py/blob/master/LICENSE.md>`_.
| Note that the corpora may have license conditions that restrict automatic downloads.

About
------

The project is maintained by `Ekaterina Gerasimenko <https://github.com/kategerasimenko>`_ and `Artyom Kopetskiy <https://github.com/akv17>`_.
At different stages, the following people have contributed to the project:
`Alexey Koshevoy <https://github.com/alexeykosh>`_,
`Anna Klezovich <https://github.com/Pandaklez)>`_,
`Anna Zueva <https://github.com/zu-ann)>`_,
Diana Malyshok,
`George Moroz <https://github.com/agricolamz>`_,
`Maria Terekhina <https://github.com/maria-terekhina>`_,
`Mark Sobolev <https://github.com/strategy155>`_,
`Michael Voronov <https://github.com/OneAdder>`_ and
`Ustinya Kosheleva <https://github.com/ustya-k>`_.

Contents
--------

.. toctree::
   :maxdepth: 2
   
   api
   corpora

Contributing
------------

Reporting a bug & requesting functionality
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can report a bug, ask a question or suggest adding features via `Issues <https://github.com/lingcorpora/lingcorpora.py/issues>`_ in the repository.

Making new corpora and proposing changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You are welcome to suggest your improvements to the source code and make APIs for more corpora. You should propose changes via `pull requests <https://help.github.com/articles/about-pull-requests/>`_. Your code should fit into the overall structure, which is described in the guide in the following guide:

.. toctree::
    
    CONTRIBUTING

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`