From 15cea1b5dc50132c9dabf3ed4072424fdb5bc610 Mon Sep 17 00:00:00 2001 From: Andre Christoga Pramaditya Date: Sun, 15 Dec 2019 16:31:43 +0700 Subject: [PATCH 1/4] Updated README with Auth Token configuration guide and more references --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b8068218..c725e5398 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ If you are interested in contributing to EvalAI-CLI, follow our [contribution gu git clone https://github.com/Cloud-CV/evalai-cli.git evalai-cli ``` -3. Create a virtual environment +3. Create a virtual environment ([Mac users could easily use Homebrew](https://gist.github.com/apavamontri/4516816)) ```bash cd EvalAI-CLI @@ -40,10 +40,23 @@ If you are interested in contributing to EvalAI-CLI, follow our [contribution gu pip install -e . ``` -5. Login to cli using the command ``` evalai login``` +5. Configure your Auth Token + 1. Create an account on the production site (https://evalai.cloudcv.org/) + 2. Verify your email + 3. Go to your profile (https://evalai.cloudcv.org/web/profile) + 4. Click on `Get your Auth Token` + 5. Copy the token + 6. Set the token using the `evalai` CLI as shown below + ```bash + evalai set_token + ``` + +6. Login to cli using the command ``` evalai login``` Two users will be created by default which are listed below - ```bash Host User - username: host, password: password Participant User - username: participant, password: password ``` + +Or you could just login into your account just by typing `evalai` and putting in your username and your password, and there you have it. From 4c03887e971bea08f4e3f80be2d3d7c655879fc5 Mon Sep 17 00:00:00 2001 From: Andre Christoga Pramaditya Date: Sun, 15 Dec 2019 20:46:31 +0700 Subject: [PATCH 2/4] Fix GitHub Case --- .github/CONTRIBUTING.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9f496bd8c..e89ec7bb9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,7 +7,7 @@ To make the process of contributing to `evalai-cli` much easier, we have some gu ### Issues Issues are a great way to contribute since they help us identify bugs as well as great new features our users might love. -We use Github's issue system for logging issues. Moreover, we like to add tags to issues to help identify priority, so if you see any tags that you would like to add to the issue, please go ahead. +We use GitHub's issue system for logging issues. Moreover, we like to add tags to issues to help identify priority, so if you see any tags that you would like to add to the issue, please go ahead. ### Pull Requests diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c5b00742c..d5e0b251f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,6 +2,6 @@ IMPORTANT NOTES (please read, then delete): The PR title should start with "Fix #bugnum: " (if applicable), followed by a clear one-line present-tense summary of the changes introduced in the PR. For example: "Fix #bugnum: Introduce the first version of the collection editor.". -Please make sure to mention "#bugnum" somewhere in the description of the PR. This enables Github to link the PR to the corresponding bug. +Please make sure to mention "#bugnum" somewhere in the description of the PR. This enables GitHub to link the PR to the corresponding bug. Please also make sure to follow the [style rules](https://github.com/Cloud-CV/evalai-cli/blob/master/.github/CONTRIBUTING.md). \ No newline at end of file From 612a91acd61239c52feb027d826ba8ae784d1cb3 Mon Sep 17 00:00:00 2001 From: Andre Christoga Pramaditya Date: Mon, 16 Dec 2019 17:20:12 +0700 Subject: [PATCH 3/4] Add space above command line, add another guide for non-mac users --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c725e5398..17474edfc 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,9 @@ If you are interested in contributing to EvalAI-CLI, follow our [contribution gu 3. Create a virtual environment ([Mac users could easily use Homebrew](https://gist.github.com/apavamontri/4516816)) + - `virtualenv` installation guide: [guide](https://pythonforundergradengineers.com/virtualenv-in-osx-linux-windows.html) + - If you're on a Mac, consider using Homebrew: [guide](https://gist.github.com/apavamontri/4516816) + ```bash cd EvalAI-CLI virtualenv -p python3 venv @@ -47,6 +50,7 @@ If you are interested in contributing to EvalAI-CLI, follow our [contribution gu 4. Click on `Get your Auth Token` 5. Copy the token 6. Set the token using the `evalai` CLI as shown below +

```bash evalai set_token ``` From ca0d28a407a46aa0a54eed6a3a78f5c00429099f Mon Sep 17 00:00:00 2001 From: Andre Christoga Pramaditya Date: Tue, 17 Dec 2019 13:41:09 +0700 Subject: [PATCH 4/4] Add guides for other OS --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 17474edfc..40f4ba33c 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,14 @@ If you are interested in contributing to EvalAI-CLI, follow our [contribution gu git clone https://github.com/Cloud-CV/evalai-cli.git evalai-cli ``` -3. Create a virtual environment ([Mac users could easily use Homebrew](https://gist.github.com/apavamontri/4516816)) +3. Create a virtual environment - - `virtualenv` installation guide: [guide](https://pythonforundergradengineers.com/virtualenv-in-osx-linux-windows.html) - - If you're on a Mac, consider using Homebrew: [guide](https://gist.github.com/apavamontri/4516816) + #### `virtualenv` installation guide: + - [Windows](https://programwithus.com/learn-to-code/Pip-and-virtualenv-on-Windows/) + - [Linux](https://www.linode.com/docs/development/python/create-a-python-virtualenv-on-ubuntu-1610/) + - [OSX](https://gist.github.com/apavamontri/4516816) + + And run the following commands: ```bash cd EvalAI-CLI