معرفی شرکت ها

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

توضیحات

Get your daily dose of xkcd directly from the terminal! 🤩

ویژگی	مقدار
سیستم عامل	-
نام فایل	dcs-xkcd-cli-2.0.0
نام	dcs-xkcd-cli
نسخه کتابخانه	2.0.0
نگهدارنده	[]
ایمیل نگهدارنده	[]
نویسنده	dotcs
ایمیل نویسنده	repositories@dotcs.me
آدرس صفحه اصلی	https://github.com/dotcs/xkcd-cli
آدرس اینترنتی	https://pypi.org/project/dcs-xkcd-cli/
مجوز	MIT

# xkcd cli tool <p align="center"> <img alt="Lint and static code analysis on develop branch" src="https://github.com/dotcs/xkcd-cli/actions/workflows/lint-sca.yaml/badge.svg?branch=develop"/> <a href="https://github.com/dotcs/xkcd-cli/blob/main/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"/></a> <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"/></a> </p> Get your daily dose of [xkcd] directly from the terminal! 🤩 https://user-images.githubusercontent.com/3976183/163873282-f586f312-2643-4b77-af79-89e344091b2f.mp4 [xkcd] is a webcomic created by [Randall Munroe][munroe]. It is a comic of Language, Math, Romance and Sarcasm and a [couple of other categories][explain-xkcd-categories]. If [kitty], [iterm] or any terminal that has support for the [sixel] file format is used as the terminal, the xkcd comic will be rendered directly in the terminal, otherwise the default viewer for PNG images is used. This tool requires [fzf] to be installed on the machine to filter available comics by their title. ## Installation ### With pip Install this package directly from the [Python Package Index (PyPI)][pypi-repo]. The CLI tool requires Python >= 3.8 to be installed. ```console $ pip install dcs-xkcd-cli ``` This will install a CLI tool named `xkcd` which can be used as described below. ### With pipx Installation with [pipx] is similar to the pip variant above, but uses `pipx` instead of `pip`. ```console $ pipx install dcs-xkcd-cli ``` Note that with pipx, this package can be tried out without the need to install it permanently. ```console $ pipx run dcs-xkcd-cli <args> ``` ## Usage ### Search by title ```console $ xkcd show ``` This functionality requires [fzf] to be installed. ### Show latest xkcd comic ```console $ xkcd show --latest ``` ### Show random xkcd comic ```console $ xkcd show --random ``` ### Show xkcd comic by its ID ```console $ xkcd show --comic-id 207 ``` ### Upscaling / width of comics By default images are upscaled to match the terminal dimensions. This behavior can be controlled with the `--terminal-scale-up / --no-terminal-scale-up` options. Images can be also rendered with an explicit width by using the `--width` CLI option. ```console $ xkcd show --comic-id 207 --no-terminal-scale-up # disable scaling $ xkcd show --comic-id 207 --width 1200 # set explicit width ``` ### Disable rendering in terminals ```console $ xkcd show --no-terminal-graphics ``` This command will disable the automatic image protocol detection and directly open the image with the help of `xdg-open` in the default image viewer. ### Disable or update cache Under the hood this tool uses a cache which is updated once per day transparently. The cache is used to remember the list of xkcd comics from the [archive]. To disable the cache, use the following command ```console $ xkcd show --no-cache ``` To update the cache manually, use the following command ```console $ xkcd update-cache ``` ## Development This repository manages Python dependencies with [poetry]. To install the package and its dependencies run: ```console $ poetry install ``` The code is formatted with [black] and type checked with [pyright]. Then run the the following commands to lint and test the code: ```console $ poetry run python -m black --check --diff . # tests for any lint issues $ poetry run python -m black . # auto-formats the code $ poetry run python -m pyright # runs static code analysis $ poetry run python -m pytest --cov="xkcd_cli/" --cov-report term --cov-report html # run tests with code coverage report ``` [fzf]: https://github.com/junegunn/fzf [kitty]: https://sw.kovidgoyal.net/kitty/ [archive]: https://xkcd.com/archive/ [xkcd]: https://xkcd.com [munroe]: https://en.wikipedia.org/wiki/Randall_Munroe [explain-xkcd-categories]: https://www.explainxkcd.com/wiki/index.php/Category:Comics_by_topic [pypi-repo]: https://pypi.org/project/dcs-xkcd-cli/ [pipx]: https://pypa.github.io/pipx/ [iterm]: https://iterm2.com/ [sixel]: https://en.wikipedia.org/wiki/Sixel [poetry]: https://python-poetry.org/ [black]: https://black.readthedocs.io/en/stable/ [pyright]: https://github.com/Microsoft/pyright

نیازمندی

مقدار	نام
>=4.11,<5.0	beautifulsoup4
>=2.27,<3.0	requests
>=0.4,<0.5	typer
>=9.1.1,<10.0.0	Pillow

زبان مورد نیاز

مقدار	نام
>=3.8,<4.0	Python

نحوه نصب

نصب پکیج whl dcs-xkcd-cli-2.0.0:

pip install dcs-xkcd-cli-2.0.0.whl

نصب پکیج tar.gz dcs-xkcd-cli-2.0.0:

pip install dcs-xkcd-cli-2.0.0.tar.gz