A command line application for adding user contributed docset feeds to Zeal.
Project description
zeal-feeds
zeal-feeds is a command line application for adding user contributed docsets to Zeal, as an alternative to looking up the URL of the XML feed and pasting in the Add Feed option.
Table of Contents
Installation
The recommended way to install zeal-feeds is via pipx, to provide an isolated installation.
$ 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.
$ pip install --user zeal-feeds
or
$ pip install zeal-feeds
Usage
To search available feeds, use zeal-feeds search
:
$ 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:
$ 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,
but the apparent lack of an npm
equivalent of pipx
for isolated installations prompted writing a Python version.
This article 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.
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 license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for zeal_feeds-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d00dd27c14ff29891ff677f2149891d6595aa93efc8a8f679a113923a9989740 |
|
MD5 | 78dd14a504f9a39e127de6fc18a9616c |
|
BLAKE2b-256 | bf5810ce70497d9c47967e153abe0a692eb5c14cc40f442213937fee23771c25 |