Updated homepage, installation, and usage docs (#429)

* New README.md for homepage
* New README.md for docs/installation (before and after), replacing old installation_guide.md
* Improved Linux installation docs
* Improved usage docs (before and after): added config file section, other minor changes
* Brings documentation back to our PyPI profile site

Author: Elliot Boschwitz

README.md

@@ -0,0 +1,69 @@
+[![PyPI](https://badge.fury.io/py/mssql-cli.svg)](https://pypi.python.org/pypi/mssql-cli)
+[![Python 2.7|3.4|3.5|3.6|3.7|3.8](https://img.shields.io/badge/python-2.7 | 3.4 | 3.5 | 3.6 | 3.7 | 3.8-blue.svg)](https://github.com/dbcli/mssql-cli)
+
+# mssql-cli
+[**mssql-cli**](https://github.com/dbcli/mssql-cli) is an interactive command line query tool for SQL Server. This open source tool works cross-platform and proud to be a part of the [dbcli](github.com/dbcli) community. 
+
+![mssql-cli Autocomplete](https://github.com/dbcli/mssql-cli/raw/master/screenshots/mssql-cli-autocomplete.gif)
+
+mssql-cli supports a rich interactive command line experience, with features such as:
+- **Auto-completion**: fewer keystrokes needed to complete complicated queries.
+- **Syntax highlighting**: highlights T-SQL keywords.
+- **Query history**: easily complete an auto-suggested query that was previously executed.
+- **Configuration file support**: customize the mssql-cli experience for your needs.
+- **Multi-line queries**: execute multiple queries at once using the multi-line edit mode.
+- **Non-interactive support**: execute a query without jumping into the interactive experience.
+
+## Quick Start
+Read the section below to quickly get started with mssql-cli. Consult the [usage guide](https://github.com/dbcli/mssql-cli/tree/master/doc/usage_guide.md) for a deeper dive into mssql-cli features.
+
+### Install mssql-cli
+Platform-specific installation instructions are below:
+| [Windows](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/windows.md#windows-installation) | [macOS](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/macos.md#macos-installation) | [Linux](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/linux.md) |
+| - | - | - |
+
+Visit the [installation reference guide](https://github.com/dbcli/mssql-cli/tree/master/doc/installation) to view all supported releases and downloads.
+
+#### Install with Linux Package Manager
+Follow the [Linux installation instructions]('https://github.com/dbcli/mssql-cli/blob/master/doc/installation/linux.md') to install mssql-cli using `apt-get`, `yum`, and other Linux package managers.
+
+#### Install with pip
+```sh
+python -m pip install mssql-cli
+```
+Please refer to the [pip installation docs](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/pip.md) for more platform-specific information.
+
+### Connect to Server
+Complete the command below to connect to your server:
+```sh
+mssql-cli -S <server URL> -d <database name> -U <username> -P <password>
+```
+
+### Exit mssql-cli
+Press **Ctrl+D** or type `quit`.
+
+### Show Options
+For general help content, pass in the `-h` parameter:
+```sh
+mssql-cli --help
+```
+
+### Usage Docs
+Please refer to the [usage guide](https://github.com/dbcli/mssql-cli/tree/master/doc/usage_guide.md) for details on options and example usage. If you are having any issues using mssql-cli, please see the [troubleshooting guide](https://github.com/dbcli/mssql-cli/blob/master/doc/troubleshooting_guide.md).
+
+## Telemetry
+The mssql-cli tool includes a telemetry feature. Please refer to the [telemetry guide](https://github.com/dbcli/mssql-cli/tree/master/doc/telemetry_guide.md) for more information.
+
+## Contributing
+If you would like to contribute to the project, please refer to the [development guide](https://github.com/dbcli/mssql-cli/tree/master/doc/development_guide.md).
+
+## Contact Us
+If you encounter any bugs or would like to leave a feature request, please file an issue in the
+[**Issues**](https://github.com/dbcli/mssql-cli/issues) section of our GitHub repo.
+
+## Code of Conduct
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
+[email protected] with any additional questions or comments.
+
+## License
+mssql-cli is licensed under the [BSD-3 license](https://github.com/dbcli/mssql-cli/blob/master/LICENSE.txt).

README.rst

@@ -76,10 +76,15 @@ def build():
 
         print_heading('Building mssql-cli pip package')
         utility.exec_command('%s --version' % PYTHON, utility.ROOT_DIR)
-        utility.exec_command('%s setup.py check -r -s bdist_wheel --plat-name %s' % (PYTHON, plat),
+        utility.exec_command('%s setup.py bdist_wheel --plat-name %s' % (PYTHON, plat),
                              utility.ROOT_DIR,
                              continue_on_error=False)
 
+        # checks if long description will render correctly
+        utility.exec_command('twine check {}'
+                             .format(os.path.join(utility.MSSQLCLI_DIST_DIRECTORY, '*')),
+                             utility.ROOT_DIR, continue_on_error=False)
+
     # Copy back the SqlToolsService binaries for this platform.
     clean_and_copy_sqltoolsservice(utility.get_current_platform())
     copy_and_rename_wheels()
@@ -126,9 +131,8 @@ def validate_package():
     # cache overshadowing actual changes made.
     current_platform = utility.get_current_platform()
 
-    mssqlcli_wheel_name = [
-        pkge for pkge in mssqlcli_wheel_dir if current_platform in pkge and
-        'dev-latest' not in pkge]
+    mssqlcli_wheel_name = [pkge for pkge in mssqlcli_wheel_dir
+                           if current_platform in pkge and 'dev-latest' not in pkge]
     utility.exec_command(
         '{0} install --no-cache-dir --no-index ./dist/{1}'.format(
             PIP,
@@ -150,6 +154,7 @@ def unit_test():
                                                          get_active_test_filepaths()),
                          utility.ROOT_DIR, continue_on_error=False)
 
+
 def unstable_unit_test():
     """
     Run all unstable unit tests.
@@ -217,7 +222,7 @@ def generate_mo(extraction_target_path, lang_name, trans_mappings, domain, local
     """
     extraction_target_dir = extraction_target_path\
         if os.path.isdir(extraction_target_path) else os.path.dirname(extraction_target_path)
-    localedir = localedir if (not localedir is None) \
+    localedir = localedir if localedir is not None \
                           else os.path.join(extraction_target_dir, 'locale')
     mo_dir = os.path.join(localedir, lang_name, 'LC_MESSAGES')
     create_dir([extraction_target_dir, 'locale', lang_name, 'LC_MESSAGES'])

build.py

@@ -0,0 +1,33 @@
+# Install mssql-cli
+
+## Official Installation of mssql-cli
+
+Select your platform for mssql-cli installation instructions:
+
+| [Windows](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/windows.md#windows-installation) | [macOS](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/macos.md#macos-installation) | [Linux](https://github.com/dbcli/mssql-cli/blob/master/doc/installation/linux.md) |
+| - | - | - |
+
+
+## Direct Downloads
+
+The instructions above are the preferred installation method. Direct downloads are provided as an alternative in the 
+scenario that your machine may not have access to the Microsoft package repository. Instructions for direct downloads can
+also be found in the links above.
+
+| Supported Platform                         |Latest Stable                 |
+|--------------------------------------------|------------------------------|
+|  Windows (x64)                             |[.whl][whl-win-x64]           |
+|  Windows (x86)                             |[.whl][whl-win-x86]           |
+|  macOS 10.12+                              |[.whl][whl-macos]             |
+|  Ubuntu 14.04+                             |[.deb][deb]                   |
+|  Debian 8.7+                               |[.deb][deb]                   |
+|  CentOS 7+                                 |[.rpm][rpm]                   |
+|  Red Hat Enterprise Linux 7+               |[.rpm][rpm]                   |
+|  openSUSE                                  |[.rpm][rpm]                   |
+|  Fedora 25+                                |[.rpm][rpm]                   |
+
+[deb]: https://packages.microsoft.com/ubuntu/14.04/prod/pool/main/m/mssql-cli/mssql-cli_0.15.0-1_all.deb
+[rpm]: https://packages.microsoft.com/rhel/7/prod/mssql-cli-0.15.0-1.el7.x86_64.rpm
+[whl-win-x64]: https://files.pythonhosted.org/packages/79/31/1be42f3632a30bb126e02cda4312b797f5f2cdef60b9c62596196a475037/mssql_cli-0.15.0-py2.py3-none-win_amd64.whl
+[whl-win-x86]: https://files.pythonhosted.org/packages/21/8c/9829c2094b4f179f9c2f4548b2ba089867f84a3758cb70575ef2a905e877/mssql_cli-0.15.0-py2.py3-none-win32.whl
+[whl-macos]: https://files.pythonhosted.org/packages/43/5d/c9af6aec5b491e7b0c5ccf00b4b8062282d6c4cfb4c0417891bd6013e299/mssql_cli-0.15.0-py2.py3-none-macosx_10_11_intel.whl