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

Updated ReadMe with Windows Installation #110

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
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
60 changes: 55 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

The goal of this package is to offer almost all the features available on the website within your terminal.

## Development Setup
## Development Setup for Linux

### Step 1:

Expand All @@ -26,11 +26,53 @@ The goal of this package is to offer almost all the features available on the we

3. Login with your credentials and move to the profile section.
gautamjajoo marked this conversation as resolved.
Show resolved Hide resolved

4. Click on `Get your Auth Token` to get the authentication token & download it as a JSON file.
4. Copy the auth token from the profile section since it would help you in setting up the project in later stage.

5. Create a folder with name `.evalai` in your home directory by using the command `mkdir ~/.evalai`.
### Step 2:

1. Clone the evalai-cli repository to your machine via git

```bash
git clone https://github.com/Cloud-CV/evalai-cli.git EvalAI-CLI
```

6. Place the downloaded authentication token in this folder by using the command `mv ~/Downloads/token.json ~/.evalai/`.
2. Create a virtual environment

```bash
cd EvalAI-CLI
virtualenv -p python3 venv
source venv/bin/activate
```

3. Install the package dependencies

```bash
pip install -r requirements.txt
```

4. Install the package locally to try it out

```bash
pip install -e .
```

5. To setup the auth token, use the token copied in Step-4 and run the following command:

```bash
evalai set_token <token>
```

## Development Setup for Windows

### Step 1:

1. Setup the development environment for EvalAI and make sure that it is running perfectly.

2. Now, Open web browser and hit the url http://127.0.0.1:8888.

3. Login with your credentials and move to the profile section.
Copy link
Member

Choose a reason for hiding this comment

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

Also, add instruction to copy the token from the profile section.


4. Copy the auth token from the profile section since it would help you in setting up the project in later stage.

### Step 2:

Expand All @@ -45,7 +87,9 @@ git clone https://github.com/Cloud-CV/evalai-cli.git EvalAI-CLI
```bash
cd EvalAI-CLI
virtualenv -p python3 venv
source venv/bin/activate
cd venv/scripts
Copy link
Contributor

Choose a reason for hiding this comment

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

@gautamjajoo I think on Windows the 'S' in scripts is capital.
Also, how about the one-liner venv\Scripts\activate?
This is the recommended syntax. (reference)

activate.bat
cd ../..
```

3. Install the package dependencies
Expand All @@ -60,6 +104,12 @@ pip install -r requirements.txt
pip install -e .
```

5. To setup the auth token, use the token copied in Step-4 and run the following command:

```bash
evalai set_token <token>
```

## Contributing Guidelines

If you are interested in contributing to EvalAI-CLI, follow our [contribution guidelines](https://github.com/Cloud-CV/evalai-cli/blob/master/.github/CONTRIBUTING.md).