| Name | dronefly-cli JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | Dronefly command-line interface |
| upload_time | 2024-03-23 08:19:59 |
| maintainer | None |
| docs_url | None |
| author | Ben Armstrong |
| requires_python | <3.13,>=3.8.1 |
| license | AGPL-3.0-or-later |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Dronefly command-line client
The dronefly-cli command-line client will provide a standalone text user
interface that can perform a usable subset of Dronefly Discord bot's
capabilities, built solely with Dronefly core.
# Installation with poetry
There are no releases of dronefly-cli yet. For now, this will get you started:
```sh
$ pip install git+https://github.com/dronefly-garden/dronefly-cli
$ dronefly
```
If all went well, you should arrive at a Dronefly `(=)` prompt where you can test
it with the `taxon` command to look up taxa by name. For example:
$\tt\textcolor{gold}{(=)}$ taxon picoides pubescens \
[*Dryobates pubescens* (Downy Woodpecker)](https://www.inaturalist.org/taxa/792988-Dryobates-pubescens) (~~Picoides pubescens~~) \
is a species with [98,638](https://www.inaturalist.org/observations?taxon_id=792988) observations in:
> Animalia > \
> Chordata > Vertebrata > \
> Aves > \
> Piciformes > \
> Picidae > Dryobates
$\tt\textcolor{gold}{(=)}$ quit
# Configuration
There is no config storage yet. You can provide the default user with `User.inat_place_id` and `User.inat_user_id` values by setting the corresponding `INAT_PLACE_ID` and `INAT_USER_ID` environment variables.
For example, with `INAT_PLACE_ID=6853`, the taxon command shows introduction means for the configured place, Nova Scotia.
On Windows, run it in [Windows Terminal](https://github.com/microsoft/terminal) for the best results, as it supports all of the rich formatting: clickable links, italics, strikethrough, and colour. This is a screenshot produced on the developer's workstation:
# Related packages
## Dronefly core
The [dronefly-core](https://github.com/dronefly-garden/dronefly-core) package is
an incomplete rewrite of [Dronefly](https://dronefly.readthedocs.io) Discord
bot's core components.
## Dronefly Discord bot
Dronefly Discord bot brings [iNaturalist](https://www.inaturalist.org) taxa,
observations, and other data from the site into conversations on the
[Discord](https://discord.com) chat platform.
Raw data
{
"_id": null,
"home_page": null,
"name": "dronefly-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Ben Armstrong",
"author_email": "synrg@debian.org",
"download_url": "https://files.pythonhosted.org/packages/f0/94/5a2944bd62e0723f1c196cd4e7ddde39a370aa3c680ad75b0978e23465ec/dronefly_cli-0.2.3.tar.gz",
"platform": null,
"description": "# Dronefly command-line client\n\nThe dronefly-cli command-line client will provide a standalone text user\ninterface that can perform a usable subset of Dronefly Discord bot's\ncapabilities, built solely with Dronefly core.\n\n# Installation with poetry\n\nThere are no releases of dronefly-cli yet. For now, this will get you started:\n\n```sh\n$ pip install git+https://github.com/dronefly-garden/dronefly-cli\n$ dronefly\n```\n\nIf all went well, you should arrive at a Dronefly `(=)` prompt where you can test\nit with the `taxon` command to look up taxa by name. For example:\n\n$\\tt\\textcolor{gold}{(=)}$ taxon picoides pubescens \\\n[*Dryobates pubescens* (Downy Woodpecker)](https://www.inaturalist.org/taxa/792988-Dryobates-pubescens) (~~Picoides pubescens~~) \\\nis a species with [98,638](https://www.inaturalist.org/observations?taxon_id=792988) observations in: \n\n> Animalia > \\\n> Chordata > Vertebrata > \\\n> Aves > \\\n> Piciformes > \\\n> Picidae > Dryobates\n\n$\\tt\\textcolor{gold}{(=)}$ quit\n\n# Configuration\n\nThere is no config storage yet. You can provide the default user with `User.inat_place_id` and `User.inat_user_id` values by setting the corresponding `INAT_PLACE_ID` and `INAT_USER_ID` environment variables.\n\nFor example, with `INAT_PLACE_ID=6853`, the taxon command shows introduction means for the configured place, Nova Scotia.\n\nOn Windows, run it in [Windows Terminal](https://github.com/microsoft/terminal) for the best results, as it supports all of the rich formatting: clickable links, italics, strikethrough, and colour. This is a screenshot produced on the developer's workstation:\n\n\n\n# Related packages\n\n## Dronefly core\n\nThe [dronefly-core](https://github.com/dronefly-garden/dronefly-core) package is\nan incomplete rewrite of [Dronefly](https://dronefly.readthedocs.io) Discord\nbot's core components.\n\n## Dronefly Discord bot\n\nDronefly Discord bot brings [iNaturalist](https://www.inaturalist.org) taxa,\nobservations, and other data from the site into conversations on the\n[Discord](https://discord.com) chat platform.\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "Dronefly command-line interface",
"version": "0.2.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eef7907b78d65dcafbda8f9f2f9d020ab3787b21976a07807789e13d685d7307",
"md5": "a285c8133e1cbd67b7395839fea57d9e",
"sha256": "35228f1c879e6127bb8d9da85fe6f64c59cb4b8906f815dfc2e7ee78696ee9b9"
},
"downloads": -1,
"filename": "dronefly_cli-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a285c8133e1cbd67b7395839fea57d9e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8.1",
"size": 21082,
"upload_time": "2024-03-23T08:19:58",
"upload_time_iso_8601": "2024-03-23T08:19:58.078297Z",
"url": "https://files.pythonhosted.org/packages/ee/f7/907b78d65dcafbda8f9f2f9d020ab3787b21976a07807789e13d685d7307/dronefly_cli-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f0945a2944bd62e0723f1c196cd4e7ddde39a370aa3c680ad75b0978e23465ec",
"md5": "03d8a3aee311d312334c1eee22708651",
"sha256": "00e109c9358ed1e1a0f81504029df4a0feee86c689cf832c2f8c95893b7f7359"
},
"downloads": -1,
"filename": "dronefly_cli-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "03d8a3aee311d312334c1eee22708651",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8.1",
"size": 20503,
"upload_time": "2024-03-23T08:19:59",
"upload_time_iso_8601": "2024-03-23T08:19:59.739694Z",
"url": "https://files.pythonhosted.org/packages/f0/94/5a2944bd62e0723f1c196cd4e7ddde39a370aa3c680ad75b0978e23465ec/dronefly_cli-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-23 08:19:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "dronefly-cli"
}
