Skip to content

Commit 3b68f8c

Browse files
committed
Update README formatting
1 parent 719b439 commit 3b68f8c

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,44 @@
11
# emosent-py
22

3-
emosent-py is a Python utility package to get Sentiment Rankings for Unicode Emojis.
3+
emosent-py is a Python utility package to get Sentiment Rankings for Unicode Emojis.
44

55
Based on the research by Kralj Novak P, Smailović J, Sluban B, Mozetič I
66
(2015) on _Sentiment of Emojis_.
77

88
Journal Link:
9-
https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0144296
9+
<https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0144296>
1010

1111
CSV Data acquired from CLARIN repository,
12-
Repository Link: http://hdl.handle.net/11356/1048
12+
Repository Link: <http://hdl.handle.net/11356/1048>
1313

1414
This project is inspired by [emoji-sentiment](https://github.com/dematerializer/emoji-sentiment), a similar utility written in JavaScript.
1515

1616
## Emoji Support
1717

18-
The complete listed of Emojis to Sentiment Ranking supported by this project
19-
can be found at
18+
The complete listed of Emojis to Sentiment Ranking supported by this project
19+
can be found at
2020
[Emoji Sentiment Ranking v1.0](http://kt.ijs.si/data/Emoji_sentiment_ranking/).
2121

2222
## Installation
2323

2424
You can install emosent-py from using `pip`:
25+
2526
```bash
2627
pip install emosent-py
2728
```
2829

2930
## Usage
3031

31-
#### Example 1
32+
### Example 1
3233

3334
```python
3435
from emosent import get_emoji_sentiment_rank
3536
get_emoji_sentiment_rank('')
3637
```
38+
3739
Output:
38-
```python
40+
41+
```python
3942
{'unicode_codepoint': '0x2764',
4043
'occurrences': 8050,
4144
'position': 0.746943086,
@@ -47,7 +50,7 @@ Output:
4750
'sentiment_score': 0.746}
4851
```
4952

50-
#### Example 2
53+
### Example 2
5154

5255
```python
5356
from emosent import get_emoji_sentiment_rank
@@ -56,8 +59,10 @@ from emosent import get_emoji_sentiment_rank
5659
# mapped to the specified character.
5760
get_emoji_sentiment_rank('😂')
5861
```
62+
5963
Output:
60-
```python
64+
65+
```python
6166
{'unicode_codepoint': '0x1f602',
6267
'occurrences': 14622,
6368
'position': 0.805100583,
@@ -69,7 +74,7 @@ Output:
6974
'sentiment_score': 0.221}
7075
```
7176

72-
#### Example 3
77+
### Example 3
7378

7479
```python
7580
from emosent import get_emoji_sentiment_rank_multiple
@@ -78,8 +83,10 @@ from emosent import get_emoji_sentiment_rank_multiple
7883
# extracts emoji sentiment ranks and their respective positions in the text.
7984
get_emoji_sentiment_rank_multiple('well done buddy! 😁👏')
8085
```
86+
8187
Output:
82-
```python
88+
89+
```python
8390
# Here, the emojis are found at positions 17 and 18 in the specified text.
8491
[{'text_position': 17,
8592
'emoji_sentiment_rank': {'unicode_codepoint': '0x1f601',
@@ -106,11 +113,11 @@ Output:
106113

107114
## Versioning
108115

109-
We use [SemVer](http://semver.org/) for versioning. For the versions available,
110-
see the
111-
[tags on this repository](https://github.com/FintelLabs/emosent-py/tags).
116+
We use [SemVer](http://semver.org/) for versioning. For the versions available,
117+
see the
118+
[tags on this repository](https://github.com/FintelLabs/emosent-py/tags).
112119

113120
## License
114121

115-
This project is licensed under the MIT License - see the
122+
This project is licensed under the MIT License - see the
116123
[LICENSE.txt](LICENSE.txt) file for more details.

0 commit comments

Comments
 (0)