<commit_before># tldr.py

[![Latest Version][1]][2]
[![Build Status][3]][4]
[![Coverage Status][5]][6]
![Python Versions][7]


Yet another python client for [tldr][].


## Install

    $ (sudo) pip install tldr.py


## Usage

### Initialize

1. clone the tldr repo to somewhere(e.g. ~/code/tldr). We will use it when we look for a
command usage.

        $ cd ~/code
        $ git clone <EMAIL>:tldr-pages/tldr.git

2. init the configuration file.

        $ tldr init
        Input the tldr repo path(absolute path): (e.g. /home/lord63/code/tldr/)
        Input your platform(linux, osx or sunos): (e.g. linux)
        Initializing the config file at ~/.tldrrc

and you configuration file should look like this:

    colors:
       command: cyan
       description: blue
       usage: green
    platform: linux
    repo_directory: /home/lord63/code/tldr

Don't worry about the `colors` option, it is for the output when you look for a command,
you can custom it by yourself.(Note that the color should be in ['black', 'red', 'green',
'yellow', 'blue', 'magenta', 'cyan', 'white'])

### Use tldr

look for a command usage:

    $ tldr find {{command}}

check for updates(so that we can get the latest man pages):

    $ tldr update

Or you can use `tldr --help` to get the help message.


## Contributing

* It sucks? Why not help me improve it? Let me know the bad things.
* Want a new feature? Feel free to file an issue for a feature request.
* Find a bug? Open an issue please, or it's better if you can send me a pull request.

Contributions are always welcome at any time! :sparkles: :cake: :sparkles:


## License

MIT.

[1]: http://img.shields.io/pypi/v/tldr.py.svg
[2]: https://pypi.python.org/pypi/tldr.py
[3]: https://travis-ci.org/lord63/tldr.py.svg
[4]: https://travis-ci.org/lord63/tldr.py
[5]: https://codecov.io/github/lord63/tldr.py/coverage.svg?branch=master
[6]: https://codecov.io/github/lord63/tldr.py?branch=master
[7]: https://img.shields.io/pypi/pyversions/tldr.py.svg
[tldr]: https://github.com/tldr-pages/tldr<commit_msg>Update readme: add simple intro<commit_after># tldr.py

[![Latest Version][1]][2]
[![Build Status][3]][4]
[![Coverage Status][5]][6]
![Python Versions][7]


Yet another python client for [tldr][].


## Intro

tldr.py is a python client for [tldr][]: simplified and community-driven man pages.
Instead of the long man pages:

![tar-man-page][]

 tldr will give you several simple yet powerful examples:

![tar-tldr-page][]

The command examples are not good? Don't worry, you can set up your own 'tldr'!
They are just markdown files and you can modify them at your ease. Don't forget to
Share them with the community!

One more thing, tldr is just a simple version for the man page, it's **NOT** an
alternative. Sometimes, you should read the man pages patiently ;)


## Install

    $ (sudo) pip install tldr.py


## Usage

### Initialize

1. clone the tldr repo to somewhere(e.g. ~/code/tldr). We will use it when we look for a
command usage.

        $ cd ~/code
        $ git clone <EMAIL>:tldr-pages/tldr.git

2. init the configuration file.

        $ tldr init
        Input the tldr repo path(absolute path): (e.g. /home/lord63/code/tldr/)
        Input your platform(linux, osx or sunos): (e.g. linux)
        Initializing the config file at ~/.tldrrc

and you configuration file should look like this:

    colors:
       command: cyan
       description: blue
       usage: green
    platform: linux
    repo_directory: /home/lord63/code/tldr

Don't worry about the `colors` option, it is for the output when you look for a command,
you can custom it by yourself.(Note that the color should be in ['black', 'red', 'green',
'yellow', 'blue', 'magenta', 'cyan', 'white'])

### Use tldr

look for a command usage:

    $ tldr find {{command}}

check for updates(so that we can get the latest man pages):

    $ tldr update

Or you can use `tldr --help` to get the help message.


## Contributing

* It sucks? Why not help me improve it? Let me know the bad things.
* Want a new feature? Feel free to file an issue for a feature request.
* Find a bug? Open an issue please, or it's better if you can send me a pull request.

Contributions are always welcome at any time! :sparkles: :cake: :sparkles:


## License

MIT.

[1]: http://img.shields.io/pypi/v/tldr.py.svg
[2]: https://pypi.python.org/pypi/tldr.py
[3]: https://travis-ci.org/lord63/tldr.py.svg
[4]: https://travis-ci.org/lord63/tldr.py
[5]: https://codecov.io/github/lord63/tldr.py/coverage.svg?branch=master
[6]: https://codecov.io/github/lord63/tldr.py?branch=master
[7]: https://img.shields.io/pypi/pyversions/tldr.py.svg
[tldr]: https://github.com/tldr-pages/tldr
[tar-man-page]: https://cloud.githubusercontent.com/assets/5268051/10731428/5b5fd2fc-7c30-11e5-8cb1-4a3a24218ede.jpeg
[tar-tldr-page]: https://cloud.githubusercontent.com/assets/5268051/10731475/95df13fc-7c30-11e5-97d8-8090b6146208.jpeg
{'fraction_non_alphanumeric': 0.13239780353874314, 'fraction_numerical': 0.02603213341468375, 'mean_word_length': 3.4386281588447654, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 16, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2510199', 'n_tokens_mistral': 1839, 'n_tokens_neox': 1726, 'n_words': 580}