py-tldr 0.6.1

New Python client for tldr pages

Py-tldr

Py-tldr is a new Python client for tldr pages based on Click.

Installation

pip install py-tldr

Usage

$ tldr --help

Usage: tldr [OPTIONS] [COMMAND]...

  Collaborative cheatsheets for console commands.

  For subcommands such as `git commit`, just keep as it is:

      tldr git commit

Options:
  -v, --version                   Show version info and exit.
  --config FILE                   Specify a config file to use.
  -p, --platform [android|common|linux|osx|sunos|windows]
                                  Override current operating system.
  -L, --language TEXT             Specify language of the page(with no
                                  fallbacks), e.g. `en`.
  -u, --update                    Update local cache with all pages.
  -h, --help                      Show this message and exit.

By default a config file will be generated in ~/.config/tldr:

page_source = "https://raw.githubusercontent.com/tldr-pages/tldr/master/pages"
language = "en"
proxy_url = ""

[cache]
enabled = true
timeout = 24
download_url = "https://tldr-pages.github.io/assets/tldr.zip"

Cache is enabled implicitly, with 24 hours as expiration time.

A proxy url can be set for convenience, proxy envs such as HTTP_PROXY will also work.

Support

Python: 3.6, 3.7, 3.8, 3.9

OS: Not fully tested on Windows so there's uncertainty with color rendering.

Changelog

See CHANGELOG

License

MIT

Credits

This package was created with cookiecutter and iamgodot/gen-pyckage project template.