Metadata-Version: 2.1
Name: wikiglot
Version: 0.1.0
Summary: Yet another wiktionary parser
Project-URL: homepage, https://github.com/jolars/wikiglot
Project-URL: documentation, https://jolars.github.io/wikiglot/
Project-URL: changelog, https://github.com/jolars/wikiglot/blob/main/CHANGELOG.md
Project-URL: tracker, https://github.com/jolars/wikiglot/issues
Author-email: Johan Larsson <johanlarsson@outlook.com>
Maintainer-email: Johan Larsson <johanlarsson@outlook.com>
License: MIT License
        
        Copyright (c) 2024 Johan Larsson
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Requires-Dist: bs4
Requires-Dist: requests
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: myst-parser; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-copybutton; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest; extra == 'tests'
Requires-Dist: sphinx; extra == 'tests'
Description-Content-Type: text/markdown

# wikiglot

[![CI](https://github.com/jolars/wikiglot/actions/workflows/ci.yml/badge.svg)](https://github.com/jolars/wikiglot/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/jolars/wikiglot/graph/badge.svg?token=7SXl0HF8QV)](https://codecov.io/gh/jolars/wikiglot)

## Overview

**wikiglot** parses entries in Wiktionary pages. It is designed to be simple and flexible.

## Installing

**wikiglot** can be installed from source via pip:

```sh
pip install git+https://github.com/jolars/wikiglot
```

## Usage

Using **wikiglot** is simple. Here's an example of how to parse the entry from the Swedish Wiktionary page for "katt" (cat):

```python
from wikiglot import Wiktionary

parser = Wiktionary("sv")

parser.lookup("katt")
```

You can also parse entries for words in other languages that are available on the Swedish Wiktionary page:

```python
parser.lookup("funicular", "en")
```

## Limitations

**wikiglot** parses Wiktionary pages one-by-one, which can be slow if you need to look up a large number of words. If that is the case, you might prefer a solution that relies on a downloaded version of Wiktionary.

## Contributing

When writing commit messages, please use the [conventional commits format](https://www.conventionalcommits.org/en/v1.0.0/).

## Versioning

wikiglot uses [semantic versioning](https://semver.org).
