1
1
# PyPoet
2
- Python library for playing with words.
2
+ Python library for playing with words, one word at a time .
3
3
4
4
## Usage
5
5
6
6
#### Help Usage
7
7
8
8
``` console
9
- usage: script.py [-h] [-r] [-s] [-a] [-m] [-hp] [-hg] [-sa] [-n NUMBER] word
9
+ gavy42@jarvis:~/PyPoet $ python3 script.py -h
10
+ usage: script.py [-h] [-r] [-s] [-a] [-m] [-hp] [-hg] [-sa] [-n NUMBER] [-f]
11
+ word
10
12
11
- PyPoet: Play with words
13
+ PyPoet: Play with words, one word at a time.
12
14
13
15
positional arguments:
14
16
word an input of the word
@@ -21,9 +23,10 @@ optional arguments:
21
23
-m, --meaning get meaning
22
24
-hp, --homophones get homophones
23
25
-hg, --homographs get homographs
24
- -sa, --sounds_alike get words that sounds alike
26
+ -sa, --sound_alike get words that sound alike
25
27
-n NUMBER, --number NUMBER
26
28
number of words should be returned
29
+ -f, --full FULL lexical analysis
27
30
```
28
31
29
32
#### Interpreter Usage
@@ -52,5 +55,17 @@ After creating an object instance as `Poet(<string>)`, these functions are avail
52
55
- `antonyms()` : Returns a list of antonyms
53
56
- `meaning()` : Returns a list of possible meanings
54
57
- `homophones()` : Returns a list of homophones
55
- - ' homographs()' : Returns a list of homographs
56
- - ' sound_alike()' : Returns a list of words that sound alike the given word
58
+ - `homographs()` : Returns a list of homographs
59
+ - `sound_alike()` : Returns a list of words that sound alike the given word
60
+
61
+ # # PyPoet's Special
62
+
63
+ - run `python3 script.py < word> - f` to get full lexical analysis of any word, in JSON format
64
+
65
+ ```console
66
+ gavy42@ jarvis:~ / PyPoet$ python3 script.py alone - f
67
+ [!][!] Starting full analysis of: alone
68
+
69
+ [* ][* ] JSON file saved in local directory named - alone_lex_analysis.json
70
+
71
+ ```
0 commit comments