-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Update Readme * Add EvalAI-CLI heading * Add review comments
- Loading branch information
1 parent
9719a9f
commit 8899194
Showing
3 changed files
with
27 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,50 @@ | ||
# EvalAI CLI | ||
# EvalAI-CLI | ||
|
||
Official Command Line utility to use EvalAI in your terminal. | ||
Official Command Line utility to use EvalAI in your terminal. | ||
|
||
This package offers almost all of the full suite of features available on the website within your terminal. | ||
------------------------------------------------------------------------------------------ | ||
|
||
[](https://gitter.im/Cloud-CV/EvalAI?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
[](https://travis-ci.org/Cloud-CV/evalai-cli) | ||
[](https://coveralls.io/github/Cloud-CV/evalai-cli?branch=master) | ||
|
||
## Goal | ||
|
||
The goal of this package is to offer almost all the features available on the website within your terminal. | ||
|
||
## Development Setup | ||
|
||
1. Clone the repository to your machine | ||
### Step 1: | ||
|
||
Setup the development environment for EvalAI and make sure that django server & submission worker is running perfectly | ||
|
||
### 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 | ||
``` | ||
|
||
2. Setup the virtual environment. | ||
2. Create a virtual environment | ||
|
||
```bash | ||
$ cd EvalAI-CLI | ||
$ virtualenv -v python3 venv | ||
$ source venv/bin/activate | ||
``` | ||
3. Install the dependencies. | ||
3. Install the package dependencies | ||
|
||
```bash | ||
$ pip install -r requirements.txt | ||
``` | ||
|
||
|
||
2. Install the package locally to try it out. | ||
4. Install the package locally to try it out | ||
|
||
```bash | ||
$ pip install -e . | ||
``` | ||
$ pip install -e . | ||
``` | ||
|
||
## 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). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.