|
1 |
| -# [:] Example Python 2 Project |
| 1 | +## Contents of the Code |
2 | 2 |
|
3 |
| -An example Python project to demonstrate [srcclr](https://www.srcclr.com) scans. |
| 3 | +### Inputs |
| 4 | +- The code includes files like `README.md`, `html.js`, `main.py`, `requirements.txt`, `sw.js`, `v.js`, and `.github/workflows/main.yml`. |
| 5 | +- Each file has specific extensions, sizes, creation and modification timestamps. |
4 | 6 |
|
5 |
| -Check out the [python3](https://github.com/srcclr/example-python/tree/python3) branch for a project that builds with Python 3. |
| 7 | +### Outputs |
| 8 | +- `main.py` includes functions to perform various operations like getting formats, preparing keys, performing operations, and resolving redirects in Python using requests and subprocess libraries. |
| 9 | +- `html.js` contains a React component for generating HTML with specific content and elements like script tags, meta tags, links, and more. |
| 10 | +- `sw.js` provides a service worker script for caching different types of resources like CSS, JS, fonts, images, and videos. |
| 11 | +- `v.js` has a script for a video related webpage where users can parse and play VIP videos. |
| 12 | +- `requirements.txt` lists Python packages required for the project. |
| 13 | +- `.github/workflows/main.yml` includes a GitHub Actions workflow that performs a review on pull requests using the Patchwork CLI tool. |
6 | 14 |
|
7 |
| -## Try me! |
8 |
| - |
9 |
| -``` |
10 |
| -brew tap srcclr/srcclr |
11 |
| -brew install srcclr |
12 |
| -srcclr activate |
13 |
| -srcclr scan --url https://github.com/srcclr/example-python |
14 |
| -``` |
| 15 | +### Usage |
| 16 | +- `html.js` can be used in a React project to generate HTML with specific elements and content. |
| 17 | +- `main.py` demonstrates functions and potential vulnerabilities involving requests and subprocess in Python code. |
| 18 | +- `sw.js` can be used as a service worker script for caching resources in a web application. |
| 19 | +- `v.js` provides a script for a video webpage allowing users to parse and play VIP videos. |
| 20 | +- `requirements.txt` lists project dependencies needed for Python packages. |
| 21 | +- `.github/workflows/main.yml` sets up a GitHub Actions workflow for PR reviews using the Patchwork CLI tool. |
0 commit comments