diff --git a/README.md b/README.md index d947254..a47aabe 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,20 @@ YouTube Summarizer is a Streamlit-based web application that allows users to gen 2. Install the required dependencies: + 2a. Using pip: + ``` pip install -r requirements.txt ``` + 2b. Using conda: + + ``` + conda env create -f environment.yml + ``` + + Note: You might need to install `conda` first. + 3. Set up environment variables: Create a `.env` file in the root directory and add the following: @@ -52,10 +62,12 @@ YouTube Summarizer is a Streamlit-based web application that allows users to gen OLLAMA_MODEL=default_model_name WHISPER_URL=http://localhost:8000/ WHISPER_MODEL=Systran/faster-whisper-large-v3 + PASTEBIN_API_KEY=your_pastebin_api_key ``` - Note: you can copy the `env.example` file to `.env` and modify the values. - Important: the `WHISPER_URL` should point to the whisper server you want to use. You can leave it as it is if you are not planning on using Whisper. + - Important: the `PASTEBIN_API_KEY` is optional, but if you want to use it, you need to get one from [Pastebin](https://pastebin.com/doc_api). ## Usage diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..e2e24c3 --- /dev/null +++ b/environment.yml @@ -0,0 +1,104 @@ +name: youlama +channels: + - conda-forge +dependencies: + - _libgcc_mutex=0.1=conda_forge + - _openmp_mutex=4.5=2_gnu + - bzip2=1.0.8=h4bc722e_7 + - ca-certificates=2024.12.14=hbcca054_0 + - ld_impl_linux-64=2.43=h712a8e2_2 + - libffi=3.4.2=h7f98852_5 + - libgcc=14.2.0=h77fa898_1 + - libgcc-ng=14.2.0=h69a702a_1 + - libgomp=14.2.0=h77fa898_1 + - liblzma=5.6.3=hb9d3cd8_1 + - libnsl=2.0.1=hd590300_0 + - libsqlite=3.47.2=hee588c1_0 + - libuuid=2.38.1=h0b41bf4_0 + - libxcrypt=4.4.36=hd590300_1 + - libzlib=1.3.1=hb9d3cd8_2 + - ncurses=6.5=he02047a_1 + - openssl=3.4.0=hb9d3cd8_0 + - pip=24.3.1=pyh8b19718_0 + - python=3.10.16=he725a3c_1_cpython + - readline=8.2=h8228510_1 + - setuptools=75.6.0=pyhff2d567_1 + - tk=8.6.13=noxft_h4845f30_101 + - wheel=0.45.1=pyhd8ed1ab_1 + - pip: + - altair==5.5.0 + - anyio==4.7.0 + - attrs==24.2.0 + - blinker==1.9.0 + - cachetools==5.5.0 + - certifi==2024.12.14 + - charset-normalizer==3.4.0 + - click==8.1.7 + - exceptiongroup==1.2.2 + - filelock==3.16.1 + - fsspec==2024.10.0 + - gitdb==4.0.11 + - gitpython==3.1.43 + - google-api-core==2.24.0 + - google-api-python-client==2.101.0 + - google-auth==2.37.0 + - google-auth-httplib2==0.2.0 + - googleapis-common-protos==1.66.0 + - gradio-client==1.5.2 + - h11==0.14.0 + - httpcore==1.0.7 + - httplib2==0.22.0 + - httpx==0.28.1 + - huggingface-hub==0.26.5 + - idna==3.10 + - importlib-metadata==7.2.1 + - jinja2==3.1.4 + - jsonschema==4.23.0 + - jsonschema-specifications==2024.10.1 + - markdown-it-py==3.0.0 + - markupsafe==3.0.2 + - mdurl==0.1.2 + - narwhals==1.18.3 + - numpy==1.26.4 + - packaging==23.2 + - pandas==2.2.3 + - pillow==10.4.0 + - proto-plus==1.25.0 + - protobuf==4.25.5 + - pyarrow==18.1.0 + - pyasn1==0.6.1 + - pyasn1-modules==0.4.1 + - pydeck==0.9.1 + - pydub==0.25.1 + - pygments==2.18.0 + - pyparsing==3.2.0 + - python-dateutil==2.9.0.post0 + - python-dotenv==1.0.1 + - pytube==15.0.0 + - pytubefix==8.8.1 + - pytz==2024.2 + - pyyaml==6.0.2 + - referencing==0.35.1 + - requests==2.31.0 + - rich==13.9.4 + - rpds-py==0.22.3 + - rsa==4.9 + - six==1.17.0 + - smmap==5.0.1 + - sniffio==1.3.1 + - streamlit==1.31.1 + - tenacity==8.5.0 + - toml==0.10.2 + - tornado==6.4.2 + - tqdm==4.67.1 + - typing-extensions==4.12.2 + - tzdata==2024.2 + - tzlocal==5.2 + - uritemplate==4.1.1 + - urllib3==2.2.3 + - validators==0.34.0 + - watchdog==6.0.0 + - websockets==14.1 + - youtube-transcript-api==0.6.2 + - yt-dlp==2024.12.13 + - zipp==3.21.0