synonym-cli


Namesynonym-cli JSON
Version 0.3.1 PyPI version JSON
download
home_pagehttps://github.com/agmmnn/syn
Summary🌾Get synonyms and antonyms of words from Thesaurus.com and other sources in your terminal, with rich output.
upload_time2023-10-08 14:09:57
maintainer
docs_urlNone
authoragmmnn
requires_python>=3.8,<4.0
license
keywords synonym antonym thesaurus cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center"><img src="https://user-images.githubusercontent.com/16024979/162848437-8da9d5d4-a234-44d3-94d8-048f92b015a6.png" alt="syn"><a alt="Github" href="https://github.com/agmmnn/syn"><img alt="GitHub release" src="https://img.shields.io/github/v/release/agmmnn/syn"></a> <a href="https://pypi.org/project/synonym-cli/"><img alt="PyPI" src="https://img.shields.io/pypi/v/synonym-cli"></a> <a href="https://pepy.tech/project/synonym-cli"><img alt="PyPI" src="https://pepy.tech/badge/synonym-cli"></a></div>

# 🌾 syn

Get synonyms and antonyms of words from [Thesaurus.com](https://www.thesaurus.com/), [Datamuse API](https://www.datamuse.com/api/) and [AlterVista](https://thesaurus.altervista.org/) in your terminal, with [rich](https://github.com/Textualize/rich) output.

# Install:

```
pip install synonym-cli
```

## Usage:

```
syn <word>
```

### Explore Mode

Returns more particular results about the given word. Uses [Datamuse API](https://www.datamuse.com/api/).

> for Web UI: https://wordwhisper.vercel.app

`$ syn dominant -d`
![](https://user-images.githubusercontent.com/16024979/209148078-309ba28e-dc59-459f-9035-b6d3d75b710f.png)

### Other Languages

For other languages you can use `--lang`, `-l` command. To use this feature, you need to get an api key from [here](https://thesaurus.altervista.org/openapi).

`$ syn -l fr belle`
![](https://user-images.githubusercontent.com/16024979/209144768-0cde6709-65d9-4142-9eae-bb4bc38e4a13.png)

`$ syn -l ru фраза`
![](https://user-images.githubusercontent.com/16024979/209144765-abca9b54-5495-4295-98f7-15acdbde7623.png)

> AlterVista's Thesaurus API supports the following languages:

> Czech: `cs`, Danish: `da`, English (US): `en`, French: `fr`, German (Germany): `de`, German (Switzerland): `de`, Greek: `el`, Hungarian: `hu`, Italian: `it`, Norwegian: `no`, Polish: `pl`, Portuguese: `pt`, Romanian: `ro`, Russian: `ru`, Slovak: `sk`, Spanish: `es`.

### Set Default Language

You can set the default language with the `--setlang <lang_code>` argument, so you don't have to give the `-l` argument every time.

```
$ syn --setlang fr
> default language is: fr
$ syn belle
> ...
```

## Arguments

```
  -h, --help      show this help message and exit
  -p, --plain     returns plain text output
  -l, --lang      <language>
  --setkey        set apikey for altervista api
  --setlang       set default language (currently default is 'en')
  --show          show settings file
  -v, --version   show program's version number and exit
```

# Contrubuting

Contributions are welcome. If you want to contribute to this list send a pull request or just open a new issue.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/agmmnn/syn",
    "name": "synonym-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "synonym,antonym,thesaurus,cli",
    "author": "agmmnn",
    "author_email": "agmmnn@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/71/25/19c55360fe18d9b96602a23f88718b26d656b4dc4144869d6e1a030b7c1f/synonym_cli-0.3.1.tar.gz",
    "platform": null,
    "description": "<div align=\"center\"><img src=\"https://user-images.githubusercontent.com/16024979/162848437-8da9d5d4-a234-44d3-94d8-048f92b015a6.png\" alt=\"syn\"><a alt=\"Github\" href=\"https://github.com/agmmnn/syn\"><img alt=\"GitHub release\" src=\"https://img.shields.io/github/v/release/agmmnn/syn\"></a> <a href=\"https://pypi.org/project/synonym-cli/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/synonym-cli\"></a> <a href=\"https://pepy.tech/project/synonym-cli\"><img alt=\"PyPI\" src=\"https://pepy.tech/badge/synonym-cli\"></a></div>\n\n# \ud83c\udf3e syn\n\nGet synonyms and antonyms of words from [Thesaurus.com](https://www.thesaurus.com/), [Datamuse API](https://www.datamuse.com/api/) and [AlterVista](https://thesaurus.altervista.org/) in your terminal, with [rich](https://github.com/Textualize/rich) output.\n\n# Install:\n\n```\npip install synonym-cli\n```\n\n## Usage:\n\n```\nsyn <word>\n```\n\n### Explore Mode\n\nReturns more particular results about the given word. Uses [Datamuse API](https://www.datamuse.com/api/).\n\n> for Web UI: https://wordwhisper.vercel.app\n\n`$ syn dominant -d`\n![](https://user-images.githubusercontent.com/16024979/209148078-309ba28e-dc59-459f-9035-b6d3d75b710f.png)\n\n### Other Languages\n\nFor other languages you can use `--lang`, `-l` command. To use this feature, you need to get an api key from [here](https://thesaurus.altervista.org/openapi).\n\n`$ syn -l fr belle`\n![](https://user-images.githubusercontent.com/16024979/209144768-0cde6709-65d9-4142-9eae-bb4bc38e4a13.png)\n\n`$ syn -l ru \u0444\u0440\u0430\u0437\u0430`\n![](https://user-images.githubusercontent.com/16024979/209144765-abca9b54-5495-4295-98f7-15acdbde7623.png)\n\n> AlterVista's Thesaurus API supports the following languages:\n\n> Czech: `cs`, Danish: `da`, English (US): `en`, French: `fr`, German (Germany): `de`, German (Switzerland): `de`, Greek: `el`, Hungarian: `hu`, Italian: `it`, Norwegian: `no`, Polish: `pl`, Portuguese: `pt`, Romanian: `ro`, Russian: `ru`, Slovak: `sk`, Spanish: `es`.\n\n### Set Default Language\n\nYou can set the default language with the `--setlang <lang_code>` argument, so you don't have to give the `-l` argument every time.\n\n```\n$ syn --setlang fr\n> default language is: fr\n$ syn belle\n> ...\n```\n\n## Arguments\n\n```\n  -h, --help      show this help message and exit\n  -p, --plain     returns plain text output\n  -l, --lang      <language>\n  --setkey        set apikey for altervista api\n  --setlang       set default language (currently default is 'en')\n  --show          show settings file\n  -v, --version   show program's version number and exit\n```\n\n# Contrubuting\n\nContributions are welcome. If you want to contribute to this list send a pull request or just open a new issue.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "\ud83c\udf3eGet synonyms and antonyms of words from Thesaurus.com and other sources in your terminal, with rich output.",
    "version": "0.3.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/agmmnn/syn/issues",
        "Changelog": "https://github.com/agmmnn/syn/releases",
        "Homepage": "https://github.com/agmmnn/syn",
        "Repository": "https://github.com/agmmnn/syn",
        "Source": "https://github.com/agmmnn/syn"
    },
    "split_keywords": [
        "synonym",
        "antonym",
        "thesaurus",
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "44ef042089577eb5c2b521beebb02c135f39e57368f43a3fa6dc93cd4d21f093",
                "md5": "39a3e05f69f0b459c43286f05a401d3a",
                "sha256": "b42496d0bd92dd580c718f61d71c0be2b28c7eebfe53ab91480bf6b29a485a7f"
            },
            "downloads": -1,
            "filename": "synonym_cli-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "39a3e05f69f0b459c43286f05a401d3a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 8731,
            "upload_time": "2023-10-08T14:09:55",
            "upload_time_iso_8601": "2023-10-08T14:09:55.869839Z",
            "url": "https://files.pythonhosted.org/packages/44/ef/042089577eb5c2b521beebb02c135f39e57368f43a3fa6dc93cd4d21f093/synonym_cli-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "712519c55360fe18d9b96602a23f88718b26d656b4dc4144869d6e1a030b7c1f",
                "md5": "705facd30b51a608a5e7e1a3388331ff",
                "sha256": "5286cc51849562d3ff8634a31c406b31173b6091a061355ee951ef24a1fe5ecb"
            },
            "downloads": -1,
            "filename": "synonym_cli-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "705facd30b51a608a5e7e1a3388331ff",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 7898,
            "upload_time": "2023-10-08T14:09:57",
            "upload_time_iso_8601": "2023-10-08T14:09:57.847572Z",
            "url": "https://files.pythonhosted.org/packages/71/25/19c55360fe18d9b96602a23f88718b26d656b4dc4144869d6e1a030b7c1f/synonym_cli-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-08 14:09:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "agmmnn",
    "github_project": "syn",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "synonym-cli"
}
        
Elapsed time: 0.21776s