diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-10 06:57:35 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-10 06:57:35 +0000 |
| commit | b27feee702c4d1bcab63dd31abec4ac999ae2d17 (patch) | |
| tree | 71f70713bc5d6c3cadd0e882d7d0be23d22a63b4 /python-tldr.spec | |
| parent | 40e06b1bcb6e48f29e5f471301cbc79b63f6cee0 (diff) | |
automatic import of python-tldr
Diffstat (limited to 'python-tldr.spec')
| -rw-r--r-- | python-tldr.spec | 552 |
1 files changed, 552 insertions, 0 deletions
diff --git a/python-tldr.spec b/python-tldr.spec new file mode 100644 index 0000000..b41a732 --- /dev/null +++ b/python-tldr.spec @@ -0,0 +1,552 @@ +%global _empty_manifest_terminate_build 0 +Name: python-tldr +Version: 3.2.0 +Release: 1 +Summary: command line client for tldr +License: MIT +URL: https://github.com/tldr-pages/tldr-python-client +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/d5/ce/26518ec917e7d15a3cd039f3a63b86a95270a84f38bb118cf3cec1546c58/tldr-3.2.0.tar.gz +BuildArch: noarch + +Requires: python3-termcolor +Requires: python3-colorama +Requires: python3-shtab + +%description +# tldr-python-client + +[](https://pypi.python.org/pypi/tldr) +[](https://github.com/tldr-pages/tldr-python-client/actions?query=branch%3Amain) + +Python command-line client for [tldr pages](https://github.com/tldr-pages/tldr). + + + +## Installation + +### from PyPI + +```bash +pip install tldr +``` + +### from Arch Linux repository + +```bash +sudo pacman -S tldr +``` + +### from Fedora packages repository + +```bash +sudo dnf install tldr +``` + +## Usage + +``` +usage: tldr [-u] [-p PLATFORM] [-s SOURCE] [-c] [-r] [-L LANGUAGE] command + +Python command line client for tldr + +positional arguments: + command command to lookup + +optional arguments: + -h, --help show this help message and exit + -v, --version show program's version number and exit + -u, --update_cache Update the local cache of pages and exit + -p PLATFORM, --platform PLATFORM + Override the operating system [linux, osx, sunos, + windows, common] + -s SOURCE, --source SOURCE + Override the default page source + -c, --color Override color stripping + -r, --render Render local markdown files + -l, --list List all available commands for operating system + -L LANGUAGE, --language LANGUAGE + Override the default language +``` + +## Configuration + +You can configure the behavior and output of the `tldr` client by setting environment variables. For example, in the `.bashrc` file: + +```bash +export TLDR_COLOR_NAME="cyan" +export TLDR_COLOR_DESCRIPTION="white" +export TLDR_COLOR_EXAMPLE="green" +export TLDR_COLOR_COMMAND="red" +export TLDR_COLOR_PARAMETER="white" +export TLDR_LANGUAGE="es" +export TLDR_CACHE_ENABLED=1 +export TLDR_CACHE_MAX_AGE=720 +export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/main/pages" +export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip" +``` + +### Cache + +Cache is downloaded from `TLDR_DOWNLOAD_CACHE_LOCATION` (defaults to the one described in [the client specification](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#caching)), unzipped and extracted into the [local cache directory](#cache-location). Pages are loaded directly from `TLDR_PAGES_SOURCE_LOCATION` if `tldr <command>` is used. + +* `TLDR_CACHE_ENABLED` (default is `1`): + * If set to `1`, the client will first try to load from cache, and fall back to fetching from the internet if the cache doesn't exist or is too old. + * If set to `0`, the client will fetch from the internet, and fall back to the cache if the page cannot be fetched from the internet. +* `TLDR_CACHE_MAX_AGE` (default is `168` hours, which is equivalent to a week): maximum age of the cache in hours to be considered as valid when `TLDR_CACHE_ENABLED` is set to `1`. + +#### Cache location + +In order of precedence: +* `$XDG_CACHE_HOME/tldr` +* `$HOME/.cache/tldr` +* `~/.cache/tldr` + +If you are experiencing issues with *tldr*, consider deleting the cache files before trying other measures. + +#### Autocomplete + +[`shtab`](https://pypi.org/project/shtab) is required for autocompletion using the `--print-completion` argument. + +```bash +# bash +tldr --print-completion bash | sudo tee "$BASH_COMPLETION_COMPAT_DIR"/tldr +# zsh (it is recommended to check where zsh/site-functions directory is located) +## for macOS: +tldr --print-completion zsh | sudo tee /usr/local/share/zsh/site-functions/_tldr +## for Linux: +tldr --print-completion zsh | sudo tee /usr/share/zsh/site-functions/_tldr +``` + +See the `shtab` [docs](https://pypi.org/project/shtab/#usage) for other installation methods and +supported shells. + +For autocomplete in [`fish`](https://fishshell.com/), while it is not supported in `shtab` yet, +please see [#183](https://github.com/tldr-pages/tldr-python-client/issues/183) for manually adding +an autocomplete for `tldr` for `fish`. + +### SSL Inspection + +For networks that sit behind a proxy, it may be necessary to disable SSL verification for the client to function. Setting the following: + +* `TLDR_ALLOW_INSECURE=1` + +will disable SSL certificate inspection. This __should be avoided__ unless absolutely necessary. + +### Colors + +Values of the `TLDR_COLOR_x` variables may consist of three parts: +* Font color: `blue, green, yellow, cyan, magenta, white, grey, red` +* Background color: `on_blue, on_cyan, on_magenta, on_white, on_grey, on_yellow, on_red, on_green` +* Additional effects, which depends on platform: `reverse, blink, dark, concealed, underline, bold` + +You may specify as many additional effects as you want, while only one of font and background color. + +Any of the values of above may be omitted. For example, you can do similar things as the following: +* `TLDR_COLOR_NAME=""` use default system font color with default background color without any effects +* `TLDR_COLOR_DESCRIPTION="white"` for white text on default system background color without any effects +* `TLDR_COLOR_NAME="cyan dark"` for dark cyan text on default system background color +* `TLDR_COLOR_NAME="on_red"` for default system font color on red background color +* `TLDR_COLOR_PARAMETER="red on_yellow underline"` for underlined red text on yellow background +* `TLDR_COLOR_NAME="bold underline"` for default system font and background colors with underline and bolded effects + +### Language + +The language that tldr will use is dependent on a number of factors. If you specify a language via the +`--language` flag, tldr will attempt to use that language and only that language. Otherwise, it will +try to use the language specified by `TLDR_LANGUAGE`. If it is not set, or the page does not exist in that language, +then tldr will use the +language set using `LANGUAGE` and `LANG` (ignoring the values `C` and `POSIX`). +If neither are set, then tldr will always attempt to get the `en` page. Finally, if `LANG` is set, it uses `LANGUAGE`, if set, +first as the priority list to try languages in, followed by `LANG` if not included in `LANGUAGE` +and `en` as fallback (assuming it does not already appear somewhere in `LANGUAGE` or `LANG`). +All language values should be set to a value that follows [RFC 1766](https://tools.ietf.org/html/rfc1766.html), +with the special exceptions of `C` and `POSIX` which are ignored. + +### Remote source + +If you wish to use your own instance of the tldr pages instead of the default repository, you +can either use the `--source` flag when using tldr or by specifying the following environment variables: + +* `TLDR_PAGES_SOURCE_LOCATION` to control where to get individual pages from + * defaults to `https://raw.githubusercontent.com/tldr-pages/tldr/main/pages` + * it can also point to local directory using `file:///path/to/directory` +* `TLDR_DOWNLOAD_CACHE_LOCATION` to control where to pull a zip of all pages from + * defaults to `https://tldr-pages.github.io/assets/tldr.zip` + + +%package -n python3-tldr +Summary: command line client for tldr +Provides: python-tldr +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-tldr +# tldr-python-client + +[](https://pypi.python.org/pypi/tldr) +[](https://github.com/tldr-pages/tldr-python-client/actions?query=branch%3Amain) + +Python command-line client for [tldr pages](https://github.com/tldr-pages/tldr). + + + +## Installation + +### from PyPI + +```bash +pip install tldr +``` + +### from Arch Linux repository + +```bash +sudo pacman -S tldr +``` + +### from Fedora packages repository + +```bash +sudo dnf install tldr +``` + +## Usage + +``` +usage: tldr [-u] [-p PLATFORM] [-s SOURCE] [-c] [-r] [-L LANGUAGE] command + +Python command line client for tldr + +positional arguments: + command command to lookup + +optional arguments: + -h, --help show this help message and exit + -v, --version show program's version number and exit + -u, --update_cache Update the local cache of pages and exit + -p PLATFORM, --platform PLATFORM + Override the operating system [linux, osx, sunos, + windows, common] + -s SOURCE, --source SOURCE + Override the default page source + -c, --color Override color stripping + -r, --render Render local markdown files + -l, --list List all available commands for operating system + -L LANGUAGE, --language LANGUAGE + Override the default language +``` + +## Configuration + +You can configure the behavior and output of the `tldr` client by setting environment variables. For example, in the `.bashrc` file: + +```bash +export TLDR_COLOR_NAME="cyan" +export TLDR_COLOR_DESCRIPTION="white" +export TLDR_COLOR_EXAMPLE="green" +export TLDR_COLOR_COMMAND="red" +export TLDR_COLOR_PARAMETER="white" +export TLDR_LANGUAGE="es" +export TLDR_CACHE_ENABLED=1 +export TLDR_CACHE_MAX_AGE=720 +export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/main/pages" +export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip" +``` + +### Cache + +Cache is downloaded from `TLDR_DOWNLOAD_CACHE_LOCATION` (defaults to the one described in [the client specification](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#caching)), unzipped and extracted into the [local cache directory](#cache-location). Pages are loaded directly from `TLDR_PAGES_SOURCE_LOCATION` if `tldr <command>` is used. + +* `TLDR_CACHE_ENABLED` (default is `1`): + * If set to `1`, the client will first try to load from cache, and fall back to fetching from the internet if the cache doesn't exist or is too old. + * If set to `0`, the client will fetch from the internet, and fall back to the cache if the page cannot be fetched from the internet. +* `TLDR_CACHE_MAX_AGE` (default is `168` hours, which is equivalent to a week): maximum age of the cache in hours to be considered as valid when `TLDR_CACHE_ENABLED` is set to `1`. + +#### Cache location + +In order of precedence: +* `$XDG_CACHE_HOME/tldr` +* `$HOME/.cache/tldr` +* `~/.cache/tldr` + +If you are experiencing issues with *tldr*, consider deleting the cache files before trying other measures. + +#### Autocomplete + +[`shtab`](https://pypi.org/project/shtab) is required for autocompletion using the `--print-completion` argument. + +```bash +# bash +tldr --print-completion bash | sudo tee "$BASH_COMPLETION_COMPAT_DIR"/tldr +# zsh (it is recommended to check where zsh/site-functions directory is located) +## for macOS: +tldr --print-completion zsh | sudo tee /usr/local/share/zsh/site-functions/_tldr +## for Linux: +tldr --print-completion zsh | sudo tee /usr/share/zsh/site-functions/_tldr +``` + +See the `shtab` [docs](https://pypi.org/project/shtab/#usage) for other installation methods and +supported shells. + +For autocomplete in [`fish`](https://fishshell.com/), while it is not supported in `shtab` yet, +please see [#183](https://github.com/tldr-pages/tldr-python-client/issues/183) for manually adding +an autocomplete for `tldr` for `fish`. + +### SSL Inspection + +For networks that sit behind a proxy, it may be necessary to disable SSL verification for the client to function. Setting the following: + +* `TLDR_ALLOW_INSECURE=1` + +will disable SSL certificate inspection. This __should be avoided__ unless absolutely necessary. + +### Colors + +Values of the `TLDR_COLOR_x` variables may consist of three parts: +* Font color: `blue, green, yellow, cyan, magenta, white, grey, red` +* Background color: `on_blue, on_cyan, on_magenta, on_white, on_grey, on_yellow, on_red, on_green` +* Additional effects, which depends on platform: `reverse, blink, dark, concealed, underline, bold` + +You may specify as many additional effects as you want, while only one of font and background color. + +Any of the values of above may be omitted. For example, you can do similar things as the following: +* `TLDR_COLOR_NAME=""` use default system font color with default background color without any effects +* `TLDR_COLOR_DESCRIPTION="white"` for white text on default system background color without any effects +* `TLDR_COLOR_NAME="cyan dark"` for dark cyan text on default system background color +* `TLDR_COLOR_NAME="on_red"` for default system font color on red background color +* `TLDR_COLOR_PARAMETER="red on_yellow underline"` for underlined red text on yellow background +* `TLDR_COLOR_NAME="bold underline"` for default system font and background colors with underline and bolded effects + +### Language + +The language that tldr will use is dependent on a number of factors. If you specify a language via the +`--language` flag, tldr will attempt to use that language and only that language. Otherwise, it will +try to use the language specified by `TLDR_LANGUAGE`. If it is not set, or the page does not exist in that language, +then tldr will use the +language set using `LANGUAGE` and `LANG` (ignoring the values `C` and `POSIX`). +If neither are set, then tldr will always attempt to get the `en` page. Finally, if `LANG` is set, it uses `LANGUAGE`, if set, +first as the priority list to try languages in, followed by `LANG` if not included in `LANGUAGE` +and `en` as fallback (assuming it does not already appear somewhere in `LANGUAGE` or `LANG`). +All language values should be set to a value that follows [RFC 1766](https://tools.ietf.org/html/rfc1766.html), +with the special exceptions of `C` and `POSIX` which are ignored. + +### Remote source + +If you wish to use your own instance of the tldr pages instead of the default repository, you +can either use the `--source` flag when using tldr or by specifying the following environment variables: + +* `TLDR_PAGES_SOURCE_LOCATION` to control where to get individual pages from + * defaults to `https://raw.githubusercontent.com/tldr-pages/tldr/main/pages` + * it can also point to local directory using `file:///path/to/directory` +* `TLDR_DOWNLOAD_CACHE_LOCATION` to control where to pull a zip of all pages from + * defaults to `https://tldr-pages.github.io/assets/tldr.zip` + + +%package help +Summary: Development documents and examples for tldr +Provides: python3-tldr-doc +%description help +# tldr-python-client + +[](https://pypi.python.org/pypi/tldr) +[](https://github.com/tldr-pages/tldr-python-client/actions?query=branch%3Amain) + +Python command-line client for [tldr pages](https://github.com/tldr-pages/tldr). + + + +## Installation + +### from PyPI + +```bash +pip install tldr +``` + +### from Arch Linux repository + +```bash +sudo pacman -S tldr +``` + +### from Fedora packages repository + +```bash +sudo dnf install tldr +``` + +## Usage + +``` +usage: tldr [-u] [-p PLATFORM] [-s SOURCE] [-c] [-r] [-L LANGUAGE] command + +Python command line client for tldr + +positional arguments: + command command to lookup + +optional arguments: + -h, --help show this help message and exit + -v, --version show program's version number and exit + -u, --update_cache Update the local cache of pages and exit + -p PLATFORM, --platform PLATFORM + Override the operating system [linux, osx, sunos, + windows, common] + -s SOURCE, --source SOURCE + Override the default page source + -c, --color Override color stripping + -r, --render Render local markdown files + -l, --list List all available commands for operating system + -L LANGUAGE, --language LANGUAGE + Override the default language +``` + +## Configuration + +You can configure the behavior and output of the `tldr` client by setting environment variables. For example, in the `.bashrc` file: + +```bash +export TLDR_COLOR_NAME="cyan" +export TLDR_COLOR_DESCRIPTION="white" +export TLDR_COLOR_EXAMPLE="green" +export TLDR_COLOR_COMMAND="red" +export TLDR_COLOR_PARAMETER="white" +export TLDR_LANGUAGE="es" +export TLDR_CACHE_ENABLED=1 +export TLDR_CACHE_MAX_AGE=720 +export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/main/pages" +export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip" +``` + +### Cache + +Cache is downloaded from `TLDR_DOWNLOAD_CACHE_LOCATION` (defaults to the one described in [the client specification](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#caching)), unzipped and extracted into the [local cache directory](#cache-location). Pages are loaded directly from `TLDR_PAGES_SOURCE_LOCATION` if `tldr <command>` is used. + +* `TLDR_CACHE_ENABLED` (default is `1`): + * If set to `1`, the client will first try to load from cache, and fall back to fetching from the internet if the cache doesn't exist or is too old. + * If set to `0`, the client will fetch from the internet, and fall back to the cache if the page cannot be fetched from the internet. +* `TLDR_CACHE_MAX_AGE` (default is `168` hours, which is equivalent to a week): maximum age of the cache in hours to be considered as valid when `TLDR_CACHE_ENABLED` is set to `1`. + +#### Cache location + +In order of precedence: +* `$XDG_CACHE_HOME/tldr` +* `$HOME/.cache/tldr` +* `~/.cache/tldr` + +If you are experiencing issues with *tldr*, consider deleting the cache files before trying other measures. + +#### Autocomplete + +[`shtab`](https://pypi.org/project/shtab) is required for autocompletion using the `--print-completion` argument. + +```bash +# bash +tldr --print-completion bash | sudo tee "$BASH_COMPLETION_COMPAT_DIR"/tldr +# zsh (it is recommended to check where zsh/site-functions directory is located) +## for macOS: +tldr --print-completion zsh | sudo tee /usr/local/share/zsh/site-functions/_tldr +## for Linux: +tldr --print-completion zsh | sudo tee /usr/share/zsh/site-functions/_tldr +``` + +See the `shtab` [docs](https://pypi.org/project/shtab/#usage) for other installation methods and +supported shells. + +For autocomplete in [`fish`](https://fishshell.com/), while it is not supported in `shtab` yet, +please see [#183](https://github.com/tldr-pages/tldr-python-client/issues/183) for manually adding +an autocomplete for `tldr` for `fish`. + +### SSL Inspection + +For networks that sit behind a proxy, it may be necessary to disable SSL verification for the client to function. Setting the following: + +* `TLDR_ALLOW_INSECURE=1` + +will disable SSL certificate inspection. This __should be avoided__ unless absolutely necessary. + +### Colors + +Values of the `TLDR_COLOR_x` variables may consist of three parts: +* Font color: `blue, green, yellow, cyan, magenta, white, grey, red` +* Background color: `on_blue, on_cyan, on_magenta, on_white, on_grey, on_yellow, on_red, on_green` +* Additional effects, which depends on platform: `reverse, blink, dark, concealed, underline, bold` + +You may specify as many additional effects as you want, while only one of font and background color. + +Any of the values of above may be omitted. For example, you can do similar things as the following: +* `TLDR_COLOR_NAME=""` use default system font color with default background color without any effects +* `TLDR_COLOR_DESCRIPTION="white"` for white text on default system background color without any effects +* `TLDR_COLOR_NAME="cyan dark"` for dark cyan text on default system background color +* `TLDR_COLOR_NAME="on_red"` for default system font color on red background color +* `TLDR_COLOR_PARAMETER="red on_yellow underline"` for underlined red text on yellow background +* `TLDR_COLOR_NAME="bold underline"` for default system font and background colors with underline and bolded effects + +### Language + +The language that tldr will use is dependent on a number of factors. If you specify a language via the +`--language` flag, tldr will attempt to use that language and only that language. Otherwise, it will +try to use the language specified by `TLDR_LANGUAGE`. If it is not set, or the page does not exist in that language, +then tldr will use the +language set using `LANGUAGE` and `LANG` (ignoring the values `C` and `POSIX`). +If neither are set, then tldr will always attempt to get the `en` page. Finally, if `LANG` is set, it uses `LANGUAGE`, if set, +first as the priority list to try languages in, followed by `LANG` if not included in `LANGUAGE` +and `en` as fallback (assuming it does not already appear somewhere in `LANGUAGE` or `LANG`). +All language values should be set to a value that follows [RFC 1766](https://tools.ietf.org/html/rfc1766.html), +with the special exceptions of `C` and `POSIX` which are ignored. + +### Remote source + +If you wish to use your own instance of the tldr pages instead of the default repository, you +can either use the `--source` flag when using tldr or by specifying the following environment variables: + +* `TLDR_PAGES_SOURCE_LOCATION` to control where to get individual pages from + * defaults to `https://raw.githubusercontent.com/tldr-pages/tldr/main/pages` + * it can also point to local directory using `file:///path/to/directory` +* `TLDR_DOWNLOAD_CACHE_LOCATION` to control where to pull a zip of all pages from + * defaults to `https://tldr-pages.github.io/assets/tldr.zip` + + +%prep +%autosetup -n tldr-3.2.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-tldr -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 3.2.0-1 +- Package Spec generated |
