| Name | siwar-api JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Python wrapper for the Siwar Arabic Lexicon API |
| upload_time | 2024-11-06 12:24:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
arabic
dictionary
lexicon
nlp
language
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Siwar API
[](https://badge.fury.io/py/siwar-api)
[](https://github.com/osama-ata/siwar-api/actions/workflows/python-package.yml)
[](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).
Raw data
{
"_id": null,
"home_page": null,
"name": "siwar-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "arabic, dictionary, lexicon, nlp, language",
"author": null,
"author_email": "Osama Ata <osama.ata@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/bd/2f/13e725652e2110e3b899d59e0b5eef10419eeaa3a6617bc82bbaacb59f0f/siwar_api-0.1.0.tar.gz",
"platform": null,
"description": "# Siwar API\n\n[](https://badge.fury.io/py/siwar-api)\n[](https://github.com/osama-ata/siwar-api/actions/workflows/python-package.yml)\n[](https://opensource.org/licenses/MIT)\n\nA 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.\n\n## Installation\n\n```bash\npip install siwar-api\n```\n\n## Quick Start\n\n- Obtian an [API key](https://siwar.ksaa.gov.sa/developers).\n\n```python\nfrom siwar import SiwarClient\n\n# Initialize client\nclient = SiwarClient(api_key='your-api-key')\n\n# Search public entries\nresults = client.search_public('\u0645\u062d\u0631\u0643')\n\n# Get lexicon information\nlexicons = client.get_public_lexicons()\n\n# Get word details\nsenses = client.get_entry_senses('\u0645\u062d\u0631\u0643')\nconjugations = client.get_entry_conjugations('\u0645\u062d\u0631\u0643')\n```\n\n## Features\n\n- Complete coverage of Siwar API endpoints\n- Support for both public and private lexicon access\n- Rich Arabic language processing utilities\n- Type hints for better IDE support\n- Comprehensive error handling\n- Detailed documentation\n\n## Documentation\n\nFor full documentation and examples, visit our [GitHub Wiki](https://github.com/osama-ata/siwar-api/wiki).\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [Siwar Arabic Lexicon](https://siwar.ksaa.gov.sa) for providing the API\n- All our [contributors](CONTRIBUTORS.md)\n- [API documentaion](https://siwar.ksaa.gov.sa/api-external)\n\n## Support\n\nIf you encounter any problems or have suggestions, please [open an issue](https://github.com/osama-ata/siwar-api/issues/new/choose).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python wrapper for the Siwar Arabic Lexicon API",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/osama-ata/siwar-api/issues",
"Homepage": "https://github.com/osama-ata/siwar-api",
"Repository": "https://github.com/osama-ata/siwar-api.git"
},
"split_keywords": [
"arabic",
" dictionary",
" lexicon",
" nlp",
" language"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc3249f2cfb797c91f7546b303326322e0a4230a99233eb097dd2fb852c2d795",
"md5": "fb70c565bbfea1e14c90afcb6fedb385",
"sha256": "45a7bf556ebcb95575af0050c9c9953614649f27d5b4ae9209a9833a1ba7417e"
},
"downloads": -1,
"filename": "siwar_api-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb70c565bbfea1e14c90afcb6fedb385",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9612,
"upload_time": "2024-11-06T12:24:14",
"upload_time_iso_8601": "2024-11-06T12:24:14.180635Z",
"url": "https://files.pythonhosted.org/packages/fc/32/49f2cfb797c91f7546b303326322e0a4230a99233eb097dd2fb852c2d795/siwar_api-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bd2f13e725652e2110e3b899d59e0b5eef10419eeaa3a6617bc82bbaacb59f0f",
"md5": "bab5e8c3f8b9b17d3da72778ffc2360c",
"sha256": "1f25f0efe23b1965e3e5de9bf20536ed664bc07c886209022d060939c6e95401"
},
"downloads": -1,
"filename": "siwar_api-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "bab5e8c3f8b9b17d3da72778ffc2360c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11125,
"upload_time": "2024-11-06T12:24:15",
"upload_time_iso_8601": "2024-11-06T12:24:15.476339Z",
"url": "https://files.pythonhosted.org/packages/bd/2f/13e725652e2110e3b899d59e0b5eef10419eeaa3a6617bc82bbaacb59f0f/siwar_api-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 12:24:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "osama-ata",
"github_project": "siwar-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "siwar-api"
}
