Skip to content

Add developer notes explaining EvalAI-CLI structure #389

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.

Sign up for GitHub

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

Open
inamanmittal-max wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add developer notes explaining EvalAI-CLI structure #389

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,15 @@ Two users will be created by default which are listed below -
Host User - username: host, password: password
Participant User - username: participant, password: password
```
## Developer Notes

This CLI is built using the `click` library.

- The main entry point is defined in `setup.py` via `console_scripts`
and maps to `evalai.main:main`.
- The `main.py` file initializes the CLI and performs checks such as
version updates before routing to subcommands.
- Each CLI command is implemented in its own module inside the `evalai/`
directory (for example, `login` is implemented in `evalai/login.py`).
- Authentication is token-based: the `login` command stores a token
locally, and other commands reuse it via shared authentication utilities.