| Name | zeal-feeds JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | A command line application for adding user contributed docset feeds to Zeal. |
| upload_time | 2024-09-13 20:13:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
docsets
zeal
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# zeal-feeds
[](https://pypi.org/project/zeal-feeds)
[](https://pypi.org/project/zeal-feeds)
[](https://github.com/smsearcy/zeal-feeds/actions)
[](https://github.com/psf/black)
[](https://github.com/charliermarsh/ruff)
-----
*zeal-feeds* is a command line application for adding user contributed docsets to [Zeal](https://zealdocs.org/),
as an alternative to looking up the URL of the XML feed and pasting in the *Add Feed* option.
**Table of Contents**
- [Installation](#installation)
- [Usage](#usage)
- [Acknowledgements](#acknowledgements)
- [License](#license)
## Installation
The recommended way to install *zeal-feeds* is via [pipx](https://pypi.org/project/pipx/),
to provide an isolated installation.
```console
$ pipx install zeal-feeds
```
Alternatively, *zeal-feeds* can be installed via `pip`,
either for the current user or into the current Python virtual environment.
> **Warning**
>
> This package will install several dependencies into the current environment.
> Consider using `pipx` to avoid dependency conflicts.
```console
$ pip install --user zeal-feeds
```
or
```console
$ pip install zeal-feeds
```
## Usage
To search available feeds, use `zeal-feeds search`:
```console
$ zeal-feeds search alpine
⠴ Loading index of user contributed docsets
Matching docsets:
Alpinejs (3.7.x/5_2021-12-14)
```
To install feeds, use `zeal-feeds install`.
The docset name needs to match the name from the `search` results:
```console
$ zeal-feeds install alpinejs attrs
Using cached index of user contributed docsets
Downloading Alpinejs ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
. Installing Alpinejs
Downloading attrs ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
. Installing attrs
```
If a docset is already installed then it will be skipped.
## Acknowledgements
This project was inspired by [zeal-user-contrib](https://github.com/jmerle/zeal-user-contrib),
but the apparent lack of an `npm` equivalent of `pipx` for isolated installations prompted writing a Python version.
This [article](https://hynek.me/articles/productive-fruit-fly-programmer/) by Hynek Schlawack for introducing Dash/Zeal.
https://zealusercontributions.vercel.app/ for providing the docset API with XML feeds for Zeal.
## Contributing
Please open an issue or pull request on GitHub if you have questions, ideas, or issues.
*zeal-feeds* uses [hatch](https://hatch.pypa.io/).
Run `hatch run lint` to run checks (Black, Ruff, and mypy) and `hatch run test:pytest` to run unit tests.
## License
`zeal-feeds` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "zeal-feeds",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "docsets, zeal",
"author": null,
"author_email": "Scott Searcy <smsearcy14@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/ff/40/352c2482461f28f176664193e2894de49b6d9666bd5b936ecf61509e12f8/zeal_feeds-0.2.3.tar.gz",
"platform": null,
"description": "# zeal-feeds\n\n[](https://pypi.org/project/zeal-feeds)\n[](https://pypi.org/project/zeal-feeds)\n[](https://github.com/smsearcy/zeal-feeds/actions)\n[](https://github.com/psf/black)\n[](https://github.com/charliermarsh/ruff)\n\n-----\n\n*zeal-feeds* is a command line application for adding user contributed docsets to [Zeal](https://zealdocs.org/),\nas an alternative to looking up the URL of the XML feed and pasting in the *Add Feed* option.\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Acknowledgements](#acknowledgements)\n- [License](#license)\n\n## Installation\n\nThe recommended way to install *zeal-feeds* is via [pipx](https://pypi.org/project/pipx/),\nto provide an isolated installation.\n\n```console\n$ pipx install zeal-feeds\n```\n\nAlternatively, *zeal-feeds* can be installed via `pip`,\neither for the current user or into the current Python virtual environment.\n\n> **Warning**\n>\n> This package will install several dependencies into the current environment.\n> Consider using `pipx` to avoid dependency conflicts.\n\n```console\n$ pip install --user zeal-feeds\n```\n\nor\n\n```console\n$ pip install zeal-feeds\n```\n\n## Usage\n\nTo search available feeds, use `zeal-feeds search`:\n\n```console\n$ zeal-feeds search alpine\n\u2834 Loading index of user contributed docsets\nMatching docsets:\nAlpinejs (3.7.x/5_2021-12-14)\n```\n\nTo install feeds, use `zeal-feeds install`.\nThe docset name needs to match the name from the `search` results:\n\n```console\n$ zeal-feeds install alpinejs attrs\nUsing cached index of user contributed docsets\nDownloading Alpinejs \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 100% 0:00:00\n. Installing Alpinejs\nDownloading attrs \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 100% 0:00:00\n. Installing attrs\n```\n\nIf a docset is already installed then it will be skipped.\n\n## Acknowledgements\n\nThis project was inspired by [zeal-user-contrib](https://github.com/jmerle/zeal-user-contrib),\nbut the apparent lack of an `npm` equivalent of `pipx` for isolated installations prompted writing a Python version.\n\nThis [article](https://hynek.me/articles/productive-fruit-fly-programmer/) by Hynek Schlawack for introducing Dash/Zeal.\n\nhttps://zealusercontributions.vercel.app/ for providing the docset API with XML feeds for Zeal.\n\n## Contributing\n\nPlease open an issue or pull request on GitHub if you have questions, ideas, or issues.\n\n*zeal-feeds* uses [hatch](https://hatch.pypa.io/).\nRun `hatch run lint` to run checks (Black, Ruff, and mypy) and `hatch run test:pytest` to run unit tests.\n\n## License\n\n`zeal-feeds` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": null,
"summary": "A command line application for adding user contributed docset feeds to Zeal.",
"version": "0.2.3",
"project_urls": {
"Documentation": "https://github.com/smsearcy/zeal-feeds#readme",
"Issues": "https://github.com/smsearcy/zeal-feeds/issues",
"Source": "https://github.com/smsearcy/zeal-feeds"
},
"split_keywords": [
"docsets",
" zeal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a8b3ec926869696eedb75c6b7678ebe983da71bb05ef11e744455c9b2f02363",
"md5": "9a4b8bf73582bfd146583b83a8d937aa",
"sha256": "8770965ca492a5f627291787b3b4acf25dc8b746f72d9202162e9bf5b4660864"
},
"downloads": -1,
"filename": "zeal_feeds-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a4b8bf73582bfd146583b83a8d937aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10152,
"upload_time": "2024-09-13T20:13:29",
"upload_time_iso_8601": "2024-09-13T20:13:29.811463Z",
"url": "https://files.pythonhosted.org/packages/3a/8b/3ec926869696eedb75c6b7678ebe983da71bb05ef11e744455c9b2f02363/zeal_feeds-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff40352c2482461f28f176664193e2894de49b6d9666bd5b936ecf61509e12f8",
"md5": "a49658bf30fdf44e9ddfd8d654608c17",
"sha256": "0016ff8e6e692ce7bfd629e0a9f85d866e7d025276a5701f317148656c1f01ba"
},
"downloads": -1,
"filename": "zeal_feeds-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "a49658bf30fdf44e9ddfd8d654608c17",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1704199,
"upload_time": "2024-09-13T20:13:31",
"upload_time_iso_8601": "2024-09-13T20:13:31.287026Z",
"url": "https://files.pythonhosted.org/packages/ff/40/352c2482461f28f176664193e2894de49b6d9666bd5b936ecf61509e12f8/zeal_feeds-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-13 20:13:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "smsearcy",
"github_project": "zeal-feeds#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zeal-feeds"
}
