Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addressed #160: Auth Token configuration guide and references #207

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ If you are interested in contributing to EvalAI-CLI, follow our [contribution gu

3. Create a virtual environment

#### `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
virtualenv -p python3 venv
Expand All @@ -40,10 +47,24 @@ 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@drepram can you add a new line after this. It looks cluttered in markdown version

<br><br>
```bash
evalai set_token <auth_token>
```

Comment on lines +50 to +61
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kudos for adding these instructions!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

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.