Metadata-Version: 2.1
Name: topalias
Version: 1.1.3
Summary: Linux bash aliases generator
Home-page: https://github.com/CSRedRat/topalias
Author: Sergey Chudakov
Author-email: csredrat@gmail.com
License: GNU General Public License v3
Keywords: topalias topaz top bash zsh alias linux python cli util history
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.5
Requires-Dist: Click (>=7.0)

# topalias

[![Build Status](https://travis-ci.com/CSRedRat/topalias.svg?branch=master)](https://travis-ci.com/CSRedRat/topalias)
[![Coverage](https://coveralls.io/repos/github/CSRedRat/topalias/badge.svg?branch=master)](https://coveralls.io/github/CSRedRat/topalias?branch=master)
[![Python Version](https://img.shields.io/pypi/pyversions/topalias.svg)](https://pypi.org/project/topalias/)
[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)

Linux bash alias generator


## Features

- Generate short alias for popular command from bash history
- Fully typed with annotations and checked with mypy, [PEP561 compatible](https://www.python.org/dev/peps/pep-0561/)


## Installation

```bash
pip install -U --user topalias
```

From source:
```bash
git clone https://github.com/CSRedRat/topalias
python topalias/setup.py install
```

## Example

Showcase how your project can be used:

```bash
topalias # check if you uses aliases in ~/.bash_aliases - analyze and print usage statistics, offers to find new simple aliases
topalias -h # print help
topalias history # analyze local bash history
topalias h --min=2 # set minimal lenght for generated acronym filter, so that exclude some short command and find long, hard, usable command
```

File path search order:
- .bash_history in current . directory
- .bash_history in home ~ directory
- example development files in topalias/data

## License

[GPLv3](https://github.com/CSRedRat/topalias/blob/master/LICENSE)


# Version history

We follow [Semantic Versions](https://semver.org/).


## Version 0.1.0

- Initial release


