From 108990cf068b110cc3830e8c88ee12d5ef829f0e Mon Sep 17 00:00:00 2001 From: Janosh Riebesell Date: Tue, 31 Aug 2021 13:51:51 +0100 Subject: [PATCH] Fix pip license error + add pip install command to readme (#1419) * fix pip license error, add pip install to readme * fix warning: the 'license_file' option is deprecated, use 'license_files' instead --- README.md | 27 +++++++++++++++++++++++++-- src/setup.cfg | 2 +- 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1117a2d4..efc4bdaa 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,46 @@ GAM is a command line tool for Google Workspace (fka G Suite) Administrators to manage domain and user settings quickly and easily. ![Build Status](https://github.com/jay0lee/GAM/workflows/Build%20and%20test%20GAM/badge.svg) + # Quick Start + ## Linux / MacOS + Open a terminal and run: -``` + +```sh bash <(curl -s -S -L https://git.io/install-gam) ``` + this will download GAM, install it and start setup. + +To install with `pip`, run + +```sh +pip install git+https://github.com/jay0lee/GAM.git#subdirectory=src +``` + +This will only download and install GAM. To start setup, simply invoke the `gam` CLI. + ## Windows + Download the MSI Installer from the [GitHub Releases] page. Install the MSI and you'll be prompted to setup GAM. + # Documentation + The GAM documentation is hosted in the [GitHub Wiki] + # Mailing List / Discussion group + The GAM mailing list / discussion group is hosted on [Google Groups]. You can join the list and interact via email, or just post from the web itself. + # Chat Room + There is a public chat room hosted in Google Chat. [Instructions to join](https://git.io/gam-chat). + # Author -GAM is maintained by Jay Lee. Please direct "how do I?" questions to [Google Groups]. + +GAM is maintained by [Jay Lee](mailto:jay0lee@gmail.com). Please direct "how do I?" questions to [Google Groups]. [GAM release]: https://git.io/gamreleases [GitHub Releases]: https://github.com/jay0lee/GAM/releases diff --git a/src/setup.cfg b/src/setup.cfg index a6f5f8e9..bedd5d8a 100644 --- a/src/setup.cfg +++ b/src/setup.cfg @@ -8,7 +8,7 @@ url = https://github.com/jay0lee/GAM author = Jay Lee author_email = jay0lee@gmail.com license = Apache -license_file = src/license.rtf +license_files = LICENSE keywords = google, oauth2, gsuite, google-apps, google-admin-sdk, google-drive, google-cloud, google-calendar, gam, google-api, oauth2-client, google-workspace classifiers = Programming Language :: Python :: 3