|
| 1 | +# Changelog |
| 2 | + |
| 3 | +## 1.0.0 (??) |
| 4 | + |
| 5 | +### Features |
| 6 | + |
| 7 | +* __breaking__ Drop support for Python 2 and Python 3.4 |
| 8 | +* __breaking__ Rename environment variable `TLDR_REMOTE_SOURCE` to `TLDR_SOURCE` |
| 9 | +* __breaking__ Remove ability to print out multiple pages at the same time |
| 10 | +* __breaking__ Make `--update` act the same as `--download_cache`, remove ability to only update currently cached pages |
| 11 | +* __breaking__ Remove `--download_cache` flag (redundant to `--update`) |
| 12 | +* __breaking__ Remove printing of tldr page to console width, and remove any ability to paint blank lines (see #98 for more info) |
| 13 | +* Verify if colors specified via environment variables are valid, fallback to default if not |
| 14 | +* Set `User-Agent` header for urlopen requests |
| 15 | +* Allow specifying endpoints for pages and cache via environment variables |
| 16 | +* Explicitly state support for Python 3.8 |
| 17 | +* Use default terminal colors instead of always white for printing text |
| 18 | +* Catch KeyboardInterrupt exception to display appropriate message |
| 19 | +* Add ability to disable SSL inspection |
| 20 | +* Add `--version` flag to cli to print out cli version and supported client specification |
| 21 | +* Move to using `long_description` and `long_description_content_type` to handle markdown README in setup.py |
| 22 | +* Add support for handling pages in other languages |
| 23 | +* Remove symlink script in-favor of entry_points again |
| 24 | +* Narrow top-level catch-all exception to only catch urllib exceptions |
| 25 | + |
| 26 | +### Fixes |
| 27 | + |
| 28 | +* Handle using `file://` as remote source for pulling pages |
| 29 | +* Improve handling of environment variable colors to not be order specific of options |
| 30 | + |
| 31 | +### Chores |
| 32 | + |
| 33 | +* Update LICENSE to LICENSE.md |
| 34 | +* Move to GitHub actions from Travis-CI |
| 35 | +* Use flake8 to lint codebase |
| 36 | + |
| 37 | +## 0.5.0 (04/01/2019) |
| 38 | + |
| 39 | +### Features |
| 40 | + |
| 41 | +* Changed `--os` flag to `--platform` to conform to client specification |
| 42 | +* Add windows as available platform to search for for `--platform` option |
| 43 | +* Add `--render` flag to parse local markdown files |
| 44 | +* Add `--download_cache` flag to pull down entire TLDR cache |
| 45 | +* Explicitly state support for Python 3.7 |
| 46 | +* Print errors to `sys.stderr` and use non-zero exit code |
| 47 | + |
| 48 | +### Fixes |
| 49 | + |
| 50 | +* Use newer raw github path to fetch pages |
| 51 | +* Detect windows as current platform from sys.platform |
| 52 | + |
| 53 | +## 0.4.4 (06/03/2018) |
| 54 | + |
| 55 | +### Fixes |
| 56 | + |
| 57 | +* Fix using http to fetch pages in 0.4.3, use https again |
| 58 | +* Fix the cli options always using their default values |
| 59 | +* Fix typo in parameter name in function definition |
| 60 | + |
| 61 | +## 0.4.3 (06/03/2018) |
| 62 | + |
| 63 | +### Features |
| 64 | + |
| 65 | +* Add `--source` option to control where to fetch page |
| 66 | +* Add support for space separated commands, fallback to showing multiple pages if concatenated name does not exist |
| 67 | +* Add `--color` option to toggle whether to strip colors or not. |
| 68 | + |
| 69 | +## 0.4.2 (01/14/2018) |
| 70 | + |
| 71 | +### Fixes |
| 72 | + |
| 73 | +* Use https for fetching pages |
| 74 | +* Use symlink over entry points for package installation |
| 75 | + |
| 76 | +### Chores |
| 77 | + |
| 78 | +* Add description of cache location to README |
| 79 | + |
| 80 | +## 0.4.1 (11/29/2017) |
| 81 | + |
| 82 | +### Fixes |
| 83 | + |
| 84 | +* Add Python 3.6 to setup.py classifiers |
| 85 | +* Check `USE_CACHE` before attempting to load from cache |
| 86 | + |
| 87 | +## 0.4.0 (06/04/2017) |
| 88 | + |
| 89 | +### Features |
| 90 | + |
| 91 | +* Update default colors to match node client (remove blue default background color) |
| 92 | +* Add top-level exception handling to catch all thrown exceptions and display generic network message |
| 93 | +* Test against Python 3.6 |
| 94 | +* Add support for setting cache location using `XDG_CACHE_HOME` environment variable for cache location |
| 95 | +* Move default cache location from `${HOME}/.tldr_cache` to `${HOME}/.cache/tldr` (if `XDG_CACHE_HOME` not set) |
| 96 | + |
| 97 | +### Fixes |
| 98 | + |
| 99 | +* Write and read from cache files using binary mode |
| 100 | + |
| 101 | +## 0.3.0 (08/15/2016) |
| 102 | + |
| 103 | +### Features |
| 104 | + |
| 105 | +* Use cache to display page by default before attempting to fetch from network, depending on age |
| 106 | +* Add configuration settings to control cache enabled and max page age before fetching via network |
| 107 | +* Add `--update` flag to update all previously cached pages |
| 108 | + |
| 109 | +### Chores |
| 110 | + |
| 111 | +* Update README with information on color configuration |
| 112 | +* Add pypi badge to README |
| 113 | + |
| 114 | +## 0.2.0 (02/01/2016) |
| 115 | + |
| 116 | +### Features |
| 117 | + |
| 118 | +* Nest `get_terminal_size()` to prevent namespace pollution |
| 119 | +* Add ability to cache fetched pages, which are used as fallback if there is network problems |
| 120 | +* Add ability to omit background colors when printing |
| 121 | +* Use `setuptools_scm` to determine version for client in setup.py |
| 122 | + |
| 123 | +### Fixes |
| 124 | + |
| 125 | +* Fix URL pointing to old location to client in setup.py |
| 126 | + |
| 127 | +## 0.1.3.1 (01/06/2016) |
| 128 | + |
| 129 | +### Features |
| 130 | + |
| 131 | +* Use setuptools-markdown to parse markdown readme for pypi |
| 132 | + |
| 133 | +### Fixes |
| 134 | + |
| 135 | +* Add missing Python 3.4 and 3.5 classifiers to setup.py |
| 136 | + |
| 137 | +## 0.1.3 (01/06/2016) |
| 138 | + |
| 139 | +### Features |
| 140 | + |
| 141 | +* Add support for parsing and painting user input parameters in tldr pages |
| 142 | + |
| 143 | +### Build |
| 144 | + |
| 145 | +* Create basic test suite |
| 146 | +* Set-up Travis test pipeline for Python 2.7, 3.3+ |
| 147 | + |
| 148 | +## 0.1.2 (12/31/2015) |
| 149 | + |
| 150 | +### Features |
| 151 | + |
| 152 | +* Migrate to tldr-pages organization from rprieto |
| 153 | +* Add ability to set display colors via environment variables |
| 154 | +* Add basic README |
| 155 | +* Replace `os.popen()` with equivalent functions from subprocess module |
| 156 | +* Add support for client for Windows |
| 157 | + |
| 158 | +## 0.1.1 (03/13/2014) |
| 159 | + |
| 160 | +* Initial Release |
0 commit comments