Grip

Notable changes

- Content is now refreshed when the file changes ([135](https://github.com/joeyespo/grip/pull/135) - thanks, [markbt][]!)
- Rename `--gfm` to `--user-content` to reduce confusion ([139](https://github.com/joeyespo/grip/pull/139))
- Fix general Readme [Task Lists](https://github.com/blog/1825-task-lists-in-all-markdown-documents) ([#149](https://github.com/joeyespo/grip/issues/149))
- Rearchitect the internals
- Add tests

Breaking changes (API)

- Reorder API function arguments for consistency
- Remove `STATIC_URL_PATH` from settings (use `Grip` constructor or the ENV variable instead)
- Remove `STYLE_URLS_SOURCE` and `STYLE_ASSET_` settings (they're now constants)
- Remove `CACHE_URL` setting (the cache URL is now `{}/cache.format(GRIPURL)`)
- Remove `github_renderer.render_content` (use `GitHubRenderer` instead)
- Remove `offline_renderer.render_content` (use `OfflineRenderer` instead)
- Remove `read_binary` and `read_text` functions (use `io.open` directly)
- Remove `resolve_readme` (use `DirectoryReader(path, force).filename_for(None)` instead)
- Remove `text.read` call in `TextReader.read(text)`
- Route Grip assets through `/__/grip` by default instead of `/`
- Raise `ReadmeNotFoundError` when a Readme is not found instead of `ValueError`
- Require a Unicode string when rendering Markdown
- Set `DEBUG` to `False` by default in settings
- Use UPPERCASE for constants

Assumptions fixed

- Update URL of GitHub assets

Bugs fixed

- Stop `--browser` from consuming all the sockets ([136](https://github.com/joeyespo/grip/pull/136) - thanks, [markbt][]!)
- Fix `--browser` to stop waiting when the server is terminated before it listens
- Fix `--browser` when listening on `0.0.0.0`
- Fix Python 2.6
- Fix Python 3.x with `python -m grip`
- Allow caching of assets that include query parameters
- Take the `route` argument into account in `Grip.render` (this was broken in the old `render_app`)
- Fix rendering Readme containing Unicode by manually decoding UTF-8 from the GitHub response

Other changes

- Add `Home.md` as a supported default file title for GitHub Wikis
- Add `AlreadyRunningError` for calling `Grip.run` while the server is already running
- Add `ReadmeNotFoundError` for cross-Python-version file-not-found errors
- Add `Grip`, a subclass of `Flask`
- Add `ReadmeAssetManager` and `GitHubAssetManager`
- Add `ReadmeReader`, `DirectoryReader`, `StdinReader`, and `TextReader`
- Add `ReadmeRenderer`, `GitHubRenderer`, and `OfflineRenderer`
- Add `grip.command.version` for printing version information (similar to `grip.command.usage`)
- Print version with `-V`
- Make `port` and `cancel_event` optional arguments in `wait_and_start_browser`
- Add `start_browser_when_ready` to wait and start the browser in a background thread
- Add the `--quiet` CLI option
- The `GRIPHOME` ENV variable now expands the user directory (`~`), e.g. `~/.config/grip`
- Add `DEFAULT_API_URL` constant as a fallback for when `api_url` is not specified in `render_content` or `GitHubRenderer`
- Add `grip_url` and its fallback constant `DEFAULT_GRIPURL` for specifying a route to serve Grip assets from
- Remove implicit dependencies in `requirements.txt`
- Readme: Add [Tips section](https://github.com/joeyespo/grip#tips)

- Enhancement: Add `GRIPHOME` environment variable for alternative `settings.py` locations ([117](https://github.com/joeyespo/grip/pull/117) - thanks, [zmwangx][]!)
- Enhancement: Allow alternative github API URL ([119](https://github.com/joeyespo/grip/pull/119) - thanks, [dandavison][]!)
- Enhancement: Change the default port to `6419` to avoid conflicts ([124](https://github.com/joeyespo/grip/pull/124))
- Enhancement: Automatically open grip in a new tab in browser ([122](https://github.com/joeyespo/grip/pull/122) - thanks, [ssundarraj][]!)
- Enhancement: Only cache styles and assets if all downloads are successful
- Enhancement: Add `--title` option to manually set the title on the rendered page ([125](https://github.com/joeyespo/grip/pull/125) - thanks, [jlhonora][]!)
- Enhancement: Render tables and lists in `render_offline` mode ([133](https://github.com/joeyespo/grip/pull/133) - thanks, [akawhy][]!)
- Bugfix: Don't print info messages to `STDOUT` for when exporting to `STDOUT` ([101](https://github.com/joeyespo/grip/issues/101))
- Bugfix: Don't swallow system exceptions
- Bugfix: Use list builder notation instead of `map` to get `default_filenames` to evaluate it to non-empty on Python 3
- Bugfix: Fix asset retrieval on both Python 2 and 3
- Bugfix: Fix `InsecureRequestWarning` problems ([111](https://github.com/joeyespo/grip/issues/111), [#128](https://github.com/joeyespo/grip/issues/128))
- Bugfix: Fix missing Octicons by properly downloading assets as binary files ([127](https://github.com/joeyespo/grip/issues/127))
- Bugfix: Add trailing slashes to directories and remove them for files so relative links are correct ([131](https://github.com/joeyespo/grip/issues/131))
- CLI: Add "Omit this to render as a normal GitHub README file." to help avoid confusion of `--gfm`
- Readme: Add note about `^D` and `^Z` on Windows ([105](https://github.com/joeyespo/grip/issues/105))
- Cleanup: PEP8

- Bugfix: Encode to UTF-8 before sending text off to GitHub to support non-`latin-1` characters ([99](https://github.com/joeyespo/grip/issues/99))

- Bugfix: Support non-ascii languages ([86](https://github.com/joeyespo/grip/issues/86))
- Bugfix: Fix links to header anchors ([94](https://github.com/joeyespo/grip/issues/94))
- Bugfix: Unpin dependencies so there's no conflict with other globally-installed packages
- Bugfix: Fix missing octicons ([95](https://github.com/joeyespo/grip/pull/95) - thanks, [madflow][]!)
- Bugfix: Fix "Could not retrieve styles" error on Windows ([90](https://github.com/joeyespo/grip/pull/90) - thanks, [alexandre-mbm][]!)
- Cleanup

- Enhancement: Add `{version}` format argument to `CACHE_DIRECTORY` so upgrades can start fresh and also drive cache clearing
- Enhancement: Allow exporting to stdout ([73](https://github.com/joeyespo/grip/issues/73))
- Enhancement: Allow reading from stdin ([72](https://github.com/joeyespo/grip/issues/72))
- Enhancement: Allow `:<port>` pattern in CLI
- Enhancement: Add a favicon  ([60](https://github.com/joeyespo/grip/issues/60))
- Enhancement: Add "GitHub rate limit" page to replace the generic 403 error ([48](https://github.com/joeyespo/grip/issues/48))
- Enhancement: Add option to clear the cache ([68](https://github.com/joeyespo/grip/issues/68))
- Enhancement: Allow storing credentials in config file ([61](https://github.com/joeyespo/grip/issues/61))
- Enhancement: Read user settings from `~/.grip`
- Enhancement: Add `__main__.py` for allowing grip to be run as a module with `python -m grip`
- Enhancement: Add `--wide` option to render as the old GitHub size (to opt out of [47](https://github.com/joeyespo/grip/issues/47))
- Enhancement: Add title to rendered page to look more like GitHub
- Bugfix: Allow using [personal auth tokens](https://github.com/settings/tokens/new?scopes=) without a username
- Bugfix: Show images from their canonical source instead of using GitHub's cache ([50](https://github.com/joeyespo/grip/issues/50))
- Bugfix: Inline assets into the exported file ([69](https://github.com/joeyespo/grip/issues/69))
- Bugfix: Cache the assets of the styles, ([56](https://github.com/joeyespo/grip/issues/56))
- Bugfix: Allow cross-platform newlines in config ([67](https://github.com/joeyespo/grip/pull/67))
- Bugfix: Fix running from another directory ([36](https://github.com/joeyespo/grip/issues/36))
- Bugfix: Move `instance_path` to `~/.grip` to cache to a non-privileged directory ([39](https://github.com/joeyespo/grip/pull/39) - thanks, [swsnider][]!)
- Bugfix: Change the default width to match GitHub's new README style ([47](https://github.com/joeyespo/grip/issues/47))
- Readme: Mention personal access tokens and link to the appropriate GitHub page ([74](https://github.com/joeyespo/grip/pull/74) - thanks, [davejamesmiller][]!)
- Readme: Add badges, more usage example, and support and contact information
- Readme: Specify that HTTPS is always used to access the GitHub API
- Readme: Document credentials and rate limit ([46](https://github.com/joeyespo/grip/issues/46))
- Readme: Document configuration options
- Readme: Clarify command line arguments and `--gfm`
- Readme: Add Known Issues section
- Infrastructure and code cleanup

- Enhancement: Add ability to export to a specific file using the CLI ([33](https://github.com/joeyespo/grip/issues/33))
- Enhancement: Python 3 compatibility ([54](https://github.com/joeyespo/grip/pull/54) - thanks, [fly][]!)
- Bugfix: Fix issue styles weren't being downloaded properly (thanks, [fly][]!)
- Bugfix: Support anchoring to section headers like GitHub ([58](https://github.com/joeyespo/grip/issues/58))
- Readme: Document rate limits and --user / --pass
- Readme: Refer to the "offline rendering" work
- Readme: Fix 'GitHub' spelling
- Extract and expose constants
- Update requirements