diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5d187f9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,52 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## [1.1.0](https://github.com/mingrammer/awesome-finder/releases/tag/v1.1.0) - 2017-10-12 + +#### Added + +* Create CHANGELOG.md +* Add `--version` option +* Add `requirements.txt` + +#### Changed + +* Rename the `awesome` binary to `awesome-hub` to avoid the conflict with awesome binary of `awesome-wm` + +## [1.0.6](https://github.com/mingrammer/awesome-finder/releases/tag/v1.0.6) - 2017-09-29 + +#### Changed + +* Improve the parsing regex for that make it possible to recognize the emoji text + + +#### Fixed + +* Fix parsing problems for `awesome-java` and `awesome-php` + +## [1.0.5](https://github.com/mingrammer/awesome-finder/releases/tag/v1.0.5) - 2017-09-13 + +#### Added + +* Add parsers for awesome-android/ios + +#### Fixed + +* Fix a bug for trying to open the non exist link of empty matched blocks + +## [1.0.4](https://github.com/mingrammer/awesome-finder/releases/tag/v1.0.4) - 2017-09-11 + +#### Fixed + +* Fix a bug that cache directory was not created + + +## [1.0.0](https://github.com/mingrammer/awesome-finder/releases/tag/v1.0.0) - 2017-09-11 + +#### Added + +* Parses the awesome repository +* Supports some awesome repository +* Open a link on awesome finder +* Supports multiple keywords query \ No newline at end of file diff --git a/README.md b/README.md index 66b5360..efc14e1 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,13 @@ pip install awesome-finder # or pip3 install awesome-finder ```bash # Find awesome things from awesome- -awesome +awesome-hub # Find awesome things from latest awesome- (not use cache) -awesome -f (--force) +awesome-hub -f (--force) # Show help messages (can see supported awesome topics) -awesome -h (--help) +awesome-hub -h (--help) ``` There are some helper keys: @@ -76,6 +76,12 @@ Details on [CONTRIBUTING](CONTRIBUTING.md)
+## Changelog + +Details on [CHANGELOG](CHANGELOG.md) + +
+ ## TODO * [ ] Query highlighting diff --git a/awesome/__init__.py b/awesome/__init__.py index 0bfdc3f..a45464b 100644 --- a/awesome/__init__.py +++ b/awesome/__init__.py @@ -1,6 +1,6 @@ """ -awesome - a TUI, for finding awesome list +awesome-hub - a TUI, for finding curated awesome list """ -__version__ = '1.0.6' +__version__ = '1.1.0' __author__ = 'mingrammer' __license__ = 'MIT' diff --git a/awesome/__main__.py b/awesome/__main__.py index 974fc12..17d56fd 100755 --- a/awesome/__main__.py +++ b/awesome/__main__.py @@ -3,6 +3,7 @@ import argparse import os +from . import __author__, __version__ from .parser_loader import load_parsers from .tui import SearchScreen @@ -23,6 +24,8 @@ def get_awesome_blocks(awesome_title, force): def parse_command(): parser = argparse.ArgumentParser(description='awesome command') + parser.add_argument('--version', action='version', version='awesome-finder version {version}, (c) 2017-2017 by {author}.'.format(version=__version__, author=__author__)) + subparsers = parser.add_subparsers(dest='title', title='title', description='The title of awesome you want to find') subparsers.required = True diff --git a/setup.py b/setup.py index 2c71d0f..2fd5ab3 100644 --- a/setup.py +++ b/setup.py @@ -70,7 +70,7 @@ def run(self): keywords='awesome finder curses tui', packages=find_packages(), entry_points={ - 'console_scripts': ['awesome=awesome.__main__:main'], + 'console_scripts': ['awesome-hub=awesome.__main__:main'], }, install_requires=REQUIRED, include_package_data=True,