raebot


Nameraebot JSON
Version 0.2.0 PyPI version JSON
download
home_page
SummaryA library that fetches definitions from the DLE
upload_time2024-02-09 11:38:26
maintainer
docs_urlNone
authorWeiwei Wang
requires_python>=3.10,<4.0
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # raebot

Search for definitions from the DLE.

This package is inspired by [pyrae](https://github.com/nachocho/pyrae), but is implemented in a way I find more
intuitive. Also, most importantly for me, synonym and antonym support.

## Installation

```bash
pip install raebot
```

## Develop

- Install poetry.
- Create a virtual environment
- run `poetry install` to install the dependencies.

TDD recommended. Add a case, then update the script to make the test pass.

PRs welcome.

## Testing

Run `poetry run pytest` to run the tests.

## Publish

If you are Weiwei or one of his robots, run `poetry publish --build` to publish a new version.

## Usage

```python
>>> from raebot import search_words
>>> from pprint import pprint

>>> pprint(search_words('hola'))

[Word(word='lindo, da',
      etymology="Del lat. limpĭdus 'limpio', 'puro'.",
      definitions=[DefinitionX(types=['adj.'],
                               definition='Hermoso, bello, grato a la vista.',
                               examples=[],
                               synonyms=['bonito',
                                         'bello',
                                         'hermoso',
                                         'precioso',
                                         'exquisito',
                                         'agraciado',
                                         'guapo',
                                         'majo'],
                               antonyms=['feo']),
                   DefinitionX(types=['adj.'],
                               definition='Perfecto, primoroso y exquisito.',
                               examples=[],
                               synonyms=[],
                               antonyms=[])],
      phrases=[Phrase(phrase='lindo don Diego',
                      definition=[Definition(types=['m. coloq.', 'desus.'],
                                             definition='lindo (‖ hombre que '
                                                        'presume de guapo).',
                                             examples=[])])])]
```

## Warning

For now it is used by me myself and I for generating anki flashcards. It may never be on feature parity with pyrae. But we shall see.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "raebot",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Weiwei Wang",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/1b/16/57cb60d525c1cf669899f43062e0949d175242d105b1c0abe3858387ea32/raebot-0.2.0.tar.gz",
    "platform": null,
    "description": "# raebot\n\nSearch for definitions from the DLE.\n\nThis package is inspired by [pyrae](https://github.com/nachocho/pyrae), but is implemented in a way I find more\nintuitive. Also, most importantly for me, synonym and antonym support.\n\n## Installation\n\n```bash\npip install raebot\n```\n\n## Develop\n\n- Install poetry.\n- Create a virtual environment\n- run `poetry install` to install the dependencies.\n\nTDD recommended. Add a case, then update the script to make the test pass.\n\nPRs welcome.\n\n## Testing\n\nRun `poetry run pytest` to run the tests.\n\n## Publish\n\nIf you are Weiwei or one of his robots, run `poetry publish --build` to publish a new version.\n\n## Usage\n\n```python\n>>> from raebot import search_words\n>>> from pprint import pprint\n\n>>> pprint(search_words('hola'))\n\n[Word(word='lindo, da',\n      etymology=\"Del lat. limp\u012ddus 'limpio', 'puro'.\",\n      definitions=[DefinitionX(types=['adj.'],\n                               definition='Hermoso, bello, grato a la vista.',\n                               examples=[],\n                               synonyms=['bonito',\n                                         'bello',\n                                         'hermoso',\n                                         'precioso',\n                                         'exquisito',\n                                         'agraciado',\n                                         'guapo',\n                                         'majo'],\n                               antonyms=['feo']),\n                   DefinitionX(types=['adj.'],\n                               definition='Perfecto, primoroso y exquisito.',\n                               examples=[],\n                               synonyms=[],\n                               antonyms=[])],\n      phrases=[Phrase(phrase='lindo don Diego',\n                      definition=[Definition(types=['m. coloq.', 'desus.'],\n                                             definition='lindo (\u2016 hombre que '\n                                                        'presume de guapo).',\n                                             examples=[])])])]\n```\n\n## Warning\n\nFor now it is used by me myself and I for generating anki flashcards. It may never be on feature parity with pyrae. But we shall see.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A library that fetches definitions from the DLE",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "084a93538ee3993923bc9e608eb47f2a001c9c2b53e3b3630b512f1e51bb0cef",
                "md5": "c3d696d6d18a689cd098ff7497ba8271",
                "sha256": "ee44b4640f22ffaf4e36b5ec585859d0ad169da83db52929c195698023097abb"
            },
            "downloads": -1,
            "filename": "raebot-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c3d696d6d18a689cd098ff7497ba8271",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 3932,
            "upload_time": "2024-02-09T11:38:24",
            "upload_time_iso_8601": "2024-02-09T11:38:24.598531Z",
            "url": "https://files.pythonhosted.org/packages/08/4a/93538ee3993923bc9e608eb47f2a001c9c2b53e3b3630b512f1e51bb0cef/raebot-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1b1657cb60d525c1cf669899f43062e0949d175242d105b1c0abe3858387ea32",
                "md5": "40cb5a20bcd81a4c4a525a2b9d5e5f11",
                "sha256": "f8e0f779db4588ca14b5ed8cf5f0c1318f699b6a2f19f0ca9b77b0d7cbdc5363"
            },
            "downloads": -1,
            "filename": "raebot-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "40cb5a20bcd81a4c4a525a2b9d5e5f11",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 3281,
            "upload_time": "2024-02-09T11:38:26",
            "upload_time_iso_8601": "2024-02-09T11:38:26.614048Z",
            "url": "https://files.pythonhosted.org/packages/1b/16/57cb60d525c1cf669899f43062e0949d175242d105b1c0abe3858387ea32/raebot-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-09 11:38:26",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "raebot"
}
        
Elapsed time: 2.40798s