Skip to content

Commit

Permalink
Updated to support pym3u8downloader 0.1.8
Browse files Browse the repository at this point in the history
  • Loading branch information
coldsofttech committed Sep 1, 2024
1 parent 901a55e commit d580e8b
Show file tree
Hide file tree
Showing 16 changed files with 454 additions and 179 deletions.
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] "
labels: bug
assignees: ''

---

**Describe the bug**
Provide a clear and concise description of the bug you’re encountering. Include what you were trying to achieve and how
the bug disrupts this process.

**Steps to Reproduce**
Outline a step-by-step guide to replicate the issue. Include any relevant screenshots if applicable. This
should be detailed enough to allow someone else to follow and observe the same behavior.
Step 1: Open ...
Step 2: Click on ...
Step 3: Go to ...
Step 4: ...

**Expected behavior**
Clearly state what you anticipated should happen during this process. This helps in understanding what the correct
outcome should be.

**Actual behavior**
Describe the actual outcome you experienced. Be specific about how this differs from the expected behavior.

**Debug Logs**
If you have debug logging enabled, please attach or include the relevant log excerpts that capture the issue. This
information is crucial for diagnosing the problem.

**Screenshots**
Attach any error/issue screenshots. This visual information is crucial for diagnosing the problem.

**Environment (please complete the following information):**

- Operating System: [e.g., Windows 10, Ubuntu 22.04, macOS Ventura]
- Python Version: [e.g., 3.12.1]
- pym3u8downloaderui Version: [e.g., 0.1.5]
- Additional Libraries/Dependencies: (if applicable)

**Additional context**
Include any additional information that may help in understanding or resolving the issue. This could be related to
recent changes, specific configurations, or external factors that might be influencing the bug.

**Possible Solution**
If you have any ideas or suggestions on how to fix the issue, please outline them here. Your insights could be valuable
in accelerating the resolution of the problem.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE] "
labels: enhancement
assignees: ''

---

**Describe the feature request**
Provide a clear and concise description of the feature you would like to see. Explain what functionality or improvement
you are proposing and how it would enhance the current experience or system.

**Describe the desired outcome**
Explain what you hope to achieve with this feature. Detail how it would benefit users or improve the system’s overall
performance or usability.

**Describe alternatives considered**
If applicable, list any alternative solutions or features you’ve considered. Explain why these alternatives might not
fully address your needs or how they differ from your proposed feature.

**Additional context**
Include any additional information that may support your feature request. This can be screenshots, mockups, use cases,
or other relevant details that help illustrate the feature’s value and implementation.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Version History

- 0.1.4: Fixed CVE-2024-35195 (latest)
- 0.1.5: Updated to support pym3u8downloader 0.1.8 (latest)
- 0.1.4: Fixed CVE-2024-35195
- 0.1.3: Fixed CVE-2024-6345
- 0.1.2: Updated Pipeline To Support Multi-OS & Added Support for PyPI Release
- 0.1.1: Introduced Linting
Expand Down
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,22 +46,34 @@ executable.
![img.png](doc_images/doc_image_executable.png)

**Step 2:** Enter the URL of the .m3u8 playlist file you wish to download into the **Input URL (.m3u8)** field.

**Step 3:** Specify the destination folder for the downloaded file by clicking the **...** button.

**Step 4:** Check `Skip SSL Verification` if you want to ignore any SSL warnings for https-based input URLs.

![img.png](doc_images/doc_image_app_window.png)

**Step 4:** Once both the input URL and output file are specified, click the **Download** button.
**Step 5:** Track the download progress within the application.
**Step 5:** Once both the input URL and output file are specified, click the **Download** button.

**Step 6:** Track the download progress within the application.

![img.png](doc_images/doc_image_download_progress.png)

**Step 6:** Upon successful completion of the download, a confirmation message will be displayed.
**Step 7:** Upon successful completion of the download, a confirmation message will be displayed.

![img.png](doc_images/doc_image_download_complete.png)

**Step 8:** To initiate a new download and reset the controls, go to **File > New**. This action resets the controls and
allows you to input a new URL and select a new output file.

**Step 9:** In case if the provided input file is identified as master playlist, you will be notified as below.

![img.png](doc_images/doc_image_master_playlist_identified.png)

**Step 10:** From the available variants, select the appropriate one and click on **Download** button again.

![img.png](doc_images/doc_image_master_playlist_variants.png)

## General Issues & Resolutions

### Invalid Input URL
Expand Down
39 changes: 39 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Security Policy

We only provide updates for the latest version of `pym3u8downloaderui`. Please ensure you are using the most recent
version, which is currently:

| Version | Supported |
|---------|--------------------|
| 0.1.5 | :white_check_mark: |

If you are using an older version, we highly recommend upgrading to the latest version to ensure you have the latest
security updates.

## Reporting a Vulnerability

If you discover a security vulnerability in `pym3u8downloaderui`, we encourage you to report it using GitHub's Private
Vulnerability Reporting feature. This method ensures that your report remains confidential and is handled securely.

### How to Report a Vulnerability

1. **Navigate to the Repository**: Go to the [pym3u8downloaderui](https://github.com/coldsofttech/pym3u8downloaderui)
GitHub Repository.

2. **Access Security Advisories**: Click on the "Security" tab, then select "Report a Vulnerability."

3. **Provide Detailed Information**:
- **Description**: Give a clear and concise description of the vulnerability.
- **Reproduction Steps**: Include steps to reproduce the vulnerability.
- **Impact**: Describe the potential impact of the vulnerability.

4. **Submit the Report**: Once all necessary details are provided, submit the report. We will review and acknowledge
your report as soon as possible.

### Best Effort on Resolution

While we will strive to resolve the reported vulnerability as promptly as possible, we cannot guarantee a specific
timeline for the resolution. We will keep you updated on the progress and may reach out for additional information if
needed.

Thank you for helping to keep `pym3u8downloaderui` secure!
Binary file modified doc_images/doc_image_app_window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc_images/doc_image_download_progress.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 3 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
pym3u8downloader
pytest~=7.4.0
setuptools~=72.1.0
requests>=2.32.0
pym3u8downloader~=0.1.8
setuptools~=74.0.0
requests~=2.32.3
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
]
},
install_requires=[
'requests',
'pym3u8downloader'
'requests~=2.32.3',
'pym3u8downloader~=0.1.8'
],
requires_python=">=3.10",
long_description=open('README.md').read(),
Expand Down
Loading

0 comments on commit d580e8b

Please sign in to comment.