Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 3.2 KB

README.md

File metadata and controls

72 lines (53 loc) · 3.2 KB
Raw

Django youtube Search

An application which fetches latest videos sorted in reverse chronological order of their publishing date-time from YouTube for a given tag/search query in a paginated response.

Installation and setup through virtualenv

Setup and running of project (Backend)

  • Fork the repository and clone it.
  • The project used pipenv to manage dependencies.
  • Install Pipenv using the following command:
pip install pipenv
  • Navigate to the project directory and initialize the environment using the following command -
pipenv shell --python 3.8
  • The above step also activates the environment, for activating the environment in subsequent sessions type the following command:
pipenv shell
  • At the root of your project directory 
pipenv install
pre-commit install

  • This will setup the project requirements and pre-commit test hooks!

  • After the above setup, run

 - python manage.py makemigrations
 - python manage.py migrate
  • Start the backend server python manage.py runserver

This runs the backend server at default port 8000. Open http://localhost:8000 to view it in the browser.

Installation and setup through docker

In order to proceed with this step, make sure you have docker and docker compose installed in your system.

  • Run the commands below:
docker-compose build
docker-compose up

This runs the backend server at default port 8000. Open http://localhost:8000 to view it in the browser.

API Routes and queries

  • localhost:8000/api/key - This route is used to add your API key for Youtube API. You can add multiple keys and it will select the key whose usage quota limit is not yet surpassed.

  • localhost:8000/api/videos - This route fetches latest videos in reverse chronological order for a predefined search query. In this example, I am using "ipl" as my query. It can be changed accordingly in backend.app.services.

  • localhost:8000/api/videos?page=n- This route returns pages of the query, where n is page number you need to see. Currently every page shows 10 videos which can be changed in backend.app.views accordingly.

  • localhost:8000/api/videos?search=<keyword> - This filters the videos containing the keyword mentioned in either title or description or both of the videos.

We can see in the image below that there are no video with keyword dog.