Python
Your repo is not done when it works on your laptop. It is done when a stranger can clone it, set it up, run it, and see useful output.
For this track, your proof is simple: a public repo with a runnable Python script, requirements.txt, sample input, and output from an API or mock API.
0 of 8 lessons done · proved by a submitted project with a public repository
Do each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 5 done
Keep your README short. A reviewer should not search for the run command.
Use commands that work from a fresh clone. If your tool needs an API key, show where it goes, but do not commit the key.
# Internship Match Helper
Reads sample student skills, calls a mock API, and writes ranked internship matches.
## Setup
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
On Windows PowerShell:
.venv\Scripts\Activate.ps1
pip install -r requirements.txt
## Run
python main.py --input data/sample_students.json --output output/matches.json
## What it does
- Reads JSON input from data/sample_students.json
- Calls a mock API in mock_api.py
- Writes useful output to output/matches.json
## Sample output
See output/sample_matches.jsonNever push API keys, tokens, or .env files. This can cost money and can get your account blocked.
If you used a real API, commit a .env.example file instead. It shows the variable names without real values.
# .env.example
API_KEY=your_api_key_here
API_URL=https://example.com/apiA screenshot is optional. Files are better. Commit a small sample input and a sample output so your project can be understood without running it first.
If your API is paid, rate-limited, or unreliable, include a mock mode. Hackathon reviewers should still be able to test your flow.
Do each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 5 done
git clone https://github.com/YOUR-USERNAME/YOUR-REPO.git
cd YOUR-REPO
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python main.py --input data/sample_students.json --output output/matches.jsonUse this before you paste the repo link into HackIndia. It prevents the common last-minute misses.
Must have:
[ ] Public GitHub repo
[ ] README with setup steps
[ ] README with run command
[ ] requirements.txt
[ ] Runnable Python script
[ ] Sample input file
[ ] Output file or output folder
[ ] API call or mock API call
[ ] No API keys or .env secrets committedDo each one yourself, then tap it to tick it off. The ticks are only a checklist for you: they are not marked or scored.
0 of 5 done
Answer the quick check to finish this lesson.