Metadata-Version: 2.1
Name: mahad
Version: 0.3.0
Summary: An Arabic text processing library intended for use in NLP applications.
Home-page: https://github.com/TRoboto/Maha
License: BSD-3-Clause
Keywords: Arabic,NLP,Text Processing,Parsers,Stream Text Processing
Author: Mohammad Al-Fetyani
Author-email: m4bh@hotmail.com
Requires-Python: >=3.7.1,<4.0.0
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: Arabic
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Dist: hijri-converter (>=2.2.3,<3.0.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
Requires-Dist: regex (>=2021.8.28,<2022.0.0)
Requires-Dist: tqdm (>=4.61.1,<5.0.0)
Requires-Dist: typing-extensions (>=3.10.0,<4.0.0)
Project-URL: Bug Tracker, https://github.com/TRoboto/Maha/issues
Project-URL: Documentation, https://maha.readthedocs.io
Project-URL: Discord, https://discord.gg/6W2tRFE7k4
Project-URL: Repository, https://github.com/TRoboto/Maha
Description-Content-Type: text/markdown

<hr />
<p align="center">
    <a href="#"><img src="https://github.com/TRoboto/Maha/raw/main/images/logo.png" width= 400px></a>
    <br />
    <br />
    <img src="https://github.com/TRoboto/maha/actions/workflows/ci.yml/badge.svg", alt="CI">
    <a href='https://maha.readthedocs.io/en/latest/?badge=latest'>
    <img src='https://readthedocs.org/projects/maha/badge/?version=latest' alt='Documentation Status' />
    </a>
    <a href="https://codecov.io/gh/TRoboto/Maha"><img src="https://codecov.io/gh/TRoboto/Maha/branch/main/graph/badge.svg?token=9CBWXT8URA", alt="codecov"></a>
    <a href="https://lgtm.com/projects/g/TRoboto/Maha/context:python"><img alt="Language grade: Python" src="https://img.shields.io/lgtm/grade/python/g/TRoboto/Maha.svg?logo=lgtm&logoWidth=18"/></a>
    <a href="https://discord.gg/6W2tRFE7k4"><img src="https://img.shields.io/discord/863503708385312769.svg?label=discord&logo=discord" alt="Discord"></a>
    <a href="https://pepy.tech/project/mahad"><img src="https://pepy.tech/badge/mahad/month" alt="Downloads"></a>
    <a href="https://opensource.org/licenses/BSD-3-Clause"><img src="https://img.shields.io/badge/License-BSD%203--Clause-blue.svg" alt="License"></a>
    <a href="https://pypi.org/project/mahad/"><img src="https://badge.fury.io/py/mahad.svg" alt="PyPI version" height="18"></a>
    <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"></a>
    <a href="http://mypy-lang.org/"><img src="http://www.mypy-lang.org/static/mypy_badge.svg" alt="Checked with mypy"></a>
    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/mahad">
    <br />
    <br />
    An Arabic text processing library intended for use in NLP applications

</p>
<hr />

Maha is a text processing library specially developed to deal with Arabic text. The beta version can be used to clean and parse text, files, and folders with or without streaming capability.

If you need help or want to discuss topics related to Maha, feel free to reach out to our [Discord](https://discord.gg/6W2tRFE7k4) server. If you would like to submit a bug report or feature request, please open an issue.

## Installation

Simply run the following to install Maha:

```bash
pip install mahad # pronounced maha d
```

For source installation, check the [documentation](https://maha.readthedocs.io/en/latest/contributing/guidelines.html).

## Overview

Check out the [overview](https://maha.readthedocs.io/en/stable/overview.html) section in the documentation to get started with Maha.

## Documentation

Documentation are hosted at [ReadTheDocs](https://maha.readthedocs.io).

## Contributing

Maha welcomes and encourages everyone to contribute. Contributions are always appreciated. Feel free to take a look at our contribution guidelines in the [documentation](https://maha.readthedocs.io/en/latest/contributing.html).

## License

Maha is BSD-licensed.

