Skip to content

Commit 560da5f

Browse files
author
patched.codes[bot]
committed
Patched README.md
1 parent f9fa7e5 commit 560da5f

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,32 @@
1-
# [:] Example Python 2 Project
1+
# Title: TBD
2+
The code provided represents a class with its initialization (`__init__`) and `run` methods. There are no specific inputs handled within the `__init__` method and any object creation would likely involve no parameters or default parameters unless extended. However, the `run` method seems to handle the business logic and is expected to take in specific keys in a dictionary type input.
23

3-
An example Python project to demonstrate [srcclr](https://www.srcclr.com) scans.
4+
## Inputs:
5+
The input information is related to the `run` method of the class. The expected input format is a dictionary and it should carry the following keys:
46

5-
Check out the [python3](https://github.com/srcclr/example-python/tree/python3) branch for a project that builds with Python 3.
7+
- `key1` _Type_: Specify the expected data type. This key is expected to carry...
8+
- `key2` _Type_: Specify the expected data type. Key 2 is expected to carry ...
9+
... (so on for all the necessary keys in the input parameter for the `run` method)
610

7-
## Try me!
11+
_Example:_
812

13+
```python
14+
run({'key1': 'value1', 'key2': 'value2', ...})
915
```
10-
brew tap srcclr/srcclr
11-
brew install srcclr
12-
srcclr activate
13-
srcclr scan --url https://github.com/srcclr/example-python
16+
17+
**Note:** The keys within the dictionary are not clearly stated in the provided code snippet therefore the keys can be changed based on the actual key names.
18+
19+
## Outputs
20+
After the execution of the `run` method, the resultant output would also be populated as a dictionary. The output dictionary is expected to have the following keys:
21+
22+
- `output_key1` _Type_: A brief description of what the value represents
23+
- `output_key2` _Type_: A brief description of what the value represents
24+
... (so on for all the necessary keys in the output that the `run` method is generating)
25+
26+
_Example:_
27+
28+
```python
29+
{'output_key1': 'output_value1', 'output_key2': 'output_value2', ...}
1430
```
31+
32+
**Note**: As the output keys and their relationships are not explicitly stated in the provided code snippet, the keys and the descriptions would need to be updated based on the actual structure of the output coming from the `run` method.

0 commit comments

Comments
 (0)