Metadata-Version: 2.1
Name: siwar-api
Version: 0.1.0
Summary: Python wrapper for the Siwar Arabic Lexicon API
Author-email: Osama Ata <osama.ata@outlook.com>
License: MIT
Project-URL: Homepage, https://github.com/osama-ata/siwar-api
Project-URL: Repository, https://github.com/osama-ata/siwar-api.git
Project-URL: Bug Tracker, https://github.com/osama-ata/siwar-api/issues
Keywords: arabic,dictionary,lexicon,nlp,language
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.25.0
Requires-Dist: python-dateutil>=2.8.2
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Requires-Dist: flake8>=3.9.0; extra == "dev"
Requires-Dist: black>=22.0.0; extra == "dev"
Requires-Dist: isort>=5.9.0; extra == "dev"
Requires-Dist: types-requests>=2.25.0; extra == "dev"
Requires-Dist: responses>=0.23.0; extra == "dev"

# Siwar API

[![PyPI version](https://badge.fury.io/py/siwar-api.svg)](https://badge.fury.io/py/siwar-api)
[![Python Package](https://github.com/osama-ata/siwar-api/actions/workflows/python-package.yml/badge.svg)](https://github.com/osama-ata/siwar-api/actions/workflows/python-package.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A Python wrapper for the Siwar Arabic Lexicon API (siwar.ksaa.gov.sa). This library provides easy access to Arabic lexical data, word meanings, roots, patterns, and morphological information.

## Installation

```bash
pip install siwar-api
```

## Quick Start

- Obtian an [API key](https://siwar.ksaa.gov.sa/developers).

```python
from siwar import SiwarClient

# Initialize client
client = SiwarClient(api_key='your-api-key')

# Search public entries
results = client.search_public('محرك')

# Get lexicon information
lexicons = client.get_public_lexicons()

# Get word details
senses = client.get_entry_senses('محرك')
conjugations = client.get_entry_conjugations('محرك')
```

## Features

- Complete coverage of Siwar API endpoints
- Support for both public and private lexicon access
- Rich Arabic language processing utilities
- Type hints for better IDE support
- Comprehensive error handling
- Detailed documentation

## Documentation

For full documentation and examples, visit our [GitHub Wiki](https://github.com/osama-ata/siwar-api/wiki).

## Contributing

We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

- [Siwar Arabic Lexicon](https://siwar.ksaa.gov.sa) for providing the API
- All our [contributors](CONTRIBUTORS.md)
- [API documentaion](https://siwar.ksaa.gov.sa/api-external)

## Support

If you encounter any problems or have suggestions, please [open an issue](https://github.com/osama-ata/siwar-api/issues/new/choose).
