Skip to content

Commit 39e66bd

Browse files
committed
update readme
1 parent a54d195 commit 39e66bd

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Python module to ease writing scripts go over big amount of data in order to per
44
Will elaborate more when it will get mature enough :)
55

66
# capabilities
7-
#####PyHacks
7+
##### PyHacks
88
Using all below capabilities to easily manage threads and queue to perform operations on Item objects.
99

1010

@@ -39,15 +39,15 @@ if __name__ == "__main__":
3939
```
4040

4141

42-
#####QueueThreads
42+
##### QueueThreads
4343
QueueThreads class allows you to manage queue and threads easily.
4444
```python
4545
qt = QueueThreads(handle_function, num_worker_threads, logger)
4646
qt.put({"counter":1, "key1":"value1"})
4747
qt.finish() # waiting until job is finished
4848
```
4949

50-
######parameters
50+
###### parameters
5151
handle_function - a function recevies item parameter from queue, will be used in all threads defined, return value has to be bool
5252
```python
5353
def handle_item(item):
@@ -67,7 +67,7 @@ def handle_item(item):
6767
num_worker_threads - numbers of threads used to run handle_functions on queue items
6868
logger - a Logger instance to be used for automatic logging
6969

70-
#####Parser
70+
##### Parser
7171
Parse files and returns list of Item objects
7272
```python
7373
parse = Parser()
@@ -77,7 +77,7 @@ for item in items:
7777
```
7878

7979

80-
#####Logger
80+
##### Logger
8181
Easy logging mechanism + writing into files under logs directory, used by QueueThreads for autoamtic logging
8282
```python
8383
logger = Logger(verbose=False)
@@ -86,7 +86,7 @@ logger.red("text")
8686
logger.yellow("text")
8787
```
8888

89-
#####Exporter
89+
##### Exporter
9090
Exporting Item objects into a csv/txt file
9191

9292
```python

0 commit comments

Comments
 (0)