NPTEL Automation API

Setup

To start contributing to the project, follow these steps:

1. Install uv

This project uses uv as a project manager. You are free to use the raw pip but using uv would be more convenient for you to work this project.

2. Create a Python Virtual Environment

Using a virtual environment helps keep your project's dependencies isolated. Follow the steps below based on your operating system:

For Windows:

uv venv
.venv\Scripts\activate

For Linux/MacOS:

uv venv
source .venv/bin/activate

2. Install Project Requirements

After activating your virtual environment, install the required packages:

uv pip install -r pyproject.toml

3. Populate environment variables

Copy the .env.example file into .env and add all key values.

4. Start development server

uvicorn app.main:app 

Contributing Guidelines

Make sure the following guidelines are followed:

• Make commits in a new branch, and then add a pull request to the test branch.
• Please install packages using the command uv add <package_name>
• Make sure you run uv pip freeze > requirements.txt in the root of the project before pushing, to ensure a seamless development experience for others.
• Ensure best practices like using docstrings and typing using Pydantic and typing package of Python.

License

This project is licensed with MIT License. For more details, click here.