# Messenger Counter
**Messenger Counter** is a python script that counts messages from Facebook Messenger and shows various statistics.
If you are interested in contributing to this repository, pull requests are much appreciated.
Note: To use this software you need to download your data directly from Facebook (in JSON format).
[How to download my data?](https://github.com/KMChris/messenger-counter#how-to-download-messages)
## Installation
```shell
pip install messenger-counter
```
## CLI usage
1. Count your messages using (insert path for your .zip file)
```shell
python -m mc count "facebook-YourName.zip"
```
2. Add flag `--chars` or `-c` to count characters (optional)
```shell
python -m mc count -c "facebook-YourName.zip"
```
3. Use following commands for different statistics (examples below)
```shell
python -m mc [-h] command [options]
```
Available commands:
* `count [-c] file` — Counts all messages/characters and saves
to _messages.json_ or _messages_chars.json_ file.
* `stats [-c] [converstion]` — Displays statistics for counted messages.
You can specify conversation for detailed statistics
and use -c for character statistics.
* `user name` — Detailed statistics for specific person
* `yearly file [conversation]` — Number of messages per year.
(please specify path to .zip file as for counting messages)
You can specify conversation for more precise statistics.
* `daily [-d DIFF] file [conversation]` — Number of messages daily.
(use `-d` or `--difference` flag to time shift by some number
of hours and show statistics differently)
* `hours [-d DIFF] file [conversation]` — Average number of messages
by hour throughout the day. (additional options as above)
## Examples
Show general statistics of all conversations
```shell
python -m mc stats
```
Show messages statistics for specific conversation.
(you can list all conversations by running previous example)
```shell
python -m mc stats JohnDoe
```
Program allows you to write only the beginning of the conversation name.
It will return first matching occurrence. (Works exactly as the previous example)
```shell
python -m mc stats Joh
```
Shows how many messages did the person send grouped by conversation.
```shell
python -m mc user "John Doe"
```
Shows how many messages on average have you send and received grouped by time of the day.
```shell
python -m mc daily "facebook-YourName.zip"
```
Similar to previous one, but limited to one conversation.
```shell
python -m mc daily "facebook-YourName.zip" John
```
## Basic module usage
Get started:
```python
import MessengerCounter as mc
mc.set_source('facebook-YourName.zip') # insert path for your .zip file
mc.count()
mc.count(chars=True)
data = mc.get_data()
mc.statistics(*data)
```
## How to download messages
1. Select Settings & Privacy in the top right of Facebook, then click Settings.
1. In the left column, click Your Facebook Information.
1. Click on Download Your Information.
1. Deselect all and select "Messages" category by clicking the box on the right side.
1. It is necessary to choose JSON format of your download request.
1. Click Create File to confirm the download request.
1. Facebook will notify you when your copy will be ready to download.
1. Go to the Available Files section.
1. Click Download and enter your password.
# Licence
**Messenger Counter** is licenced under [MIT Licence](https://opensource.org/licenses/MIT).
Raw data
{
"_id": null,
"home_page": null,
"name": "messenger-counter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "chart,count,counter,facebook,messages,messenger,statistics,stats",
"author": null,
"author_email": "Krzysztof Mizga\u0142a <krzysztof@mizgala.pl>",
"download_url": "https://files.pythonhosted.org/packages/79/65/d8cf7960e86483b132876059d8db2c54f21e7e5c255b10c9767e01f23167/messenger_counter-0.5.1.tar.gz",
"platform": null,
"description": "# Messenger Counter\n\n\n\n\n\n**Messenger Counter** is a python script that counts messages from Facebook Messenger and shows various statistics.\n\nIf you are interested in contributing to this repository, pull requests are much appreciated.\n\nNote: To use this software you need to download your data directly from Facebook (in JSON format).\n[How to download my data?](https://github.com/KMChris/messenger-counter#how-to-download-messages)\n\n## Installation \n\n```shell\npip install messenger-counter\n```\n\n## CLI usage\n\n1. Count your messages using (insert path for your .zip file)\n```shell\npython -m mc count \"facebook-YourName.zip\"\n```\n2. Add flag `--chars` or `-c` to count characters (optional)\n```shell\npython -m mc count -c \"facebook-YourName.zip\"\n```\n3. Use following commands for different statistics (examples below)\n```shell\npython -m mc [-h] command [options]\n```\nAvailable commands:\n* `count [-c] file` — Counts all messages/characters and saves\n to _messages.json_ or _messages_chars.json_ file.\n* `stats [-c] [converstion]` — Displays statistics for counted messages.\n You can specify conversation for detailed statistics\n and use -c for character statistics.\n* `user name` — Detailed statistics for specific person\n* `yearly file [conversation]` — Number of messages per year.\n (please specify path to .zip file as for counting messages)\n You can specify conversation for more precise statistics. \n* `daily [-d DIFF] file [conversation]` — Number of messages daily.\n (use `-d` or `--difference` flag to time shift by some number\n of hours and show statistics differently)\n* `hours [-d DIFF] file [conversation]` — Average number of messages\n by hour throughout the day. (additional options as above)\n\n## Examples\n\nShow general statistics of all conversations\n```shell\npython -m mc stats\n```\n\nShow messages statistics for specific conversation.\n(you can list all conversations by running previous example) \n```shell\npython -m mc stats JohnDoe\n```\n\nProgram allows you to write only the beginning of the conversation name.\nIt will return first matching occurrence. (Works exactly as the previous example)\n```shell\npython -m mc stats Joh\n```\n\nShows how many messages did the person send grouped by conversation.\n```shell\npython -m mc user \"John Doe\"\n```\n\nShows how many messages on average have you send and received grouped by time of the day.\n```shell\npython -m mc daily \"facebook-YourName.zip\"\n```\n\nSimilar to previous one, but limited to one conversation.\n```shell\npython -m mc daily \"facebook-YourName.zip\" John\n```\n\n## Basic module usage\n\nGet started:\n```python\nimport MessengerCounter as mc\nmc.set_source('facebook-YourName.zip') # insert path for your .zip file\nmc.count()\nmc.count(chars=True)\ndata = mc.get_data()\nmc.statistics(*data)\n```\n\n## How to download messages\n\n1. Select Settings & Privacy in the top right of Facebook, then click Settings.\n1. In the left column, click Your Facebook Information.\n1. Click on Download Your Information.\n\n1. Deselect all and select \"Messages\" category by clicking the box on the right side.\n1. It is necessary to choose JSON format of your download request.\n\n1. Click Create File to confirm the download request.\n1. Facebook will notify you when your copy will be ready to download.\n1. Go to the Available Files section.\n1. Click Download and enter your password.\n\n# Licence\n\n\n**Messenger Counter** is licenced under [MIT Licence](https://opensource.org/licenses/MIT).\n",
"bugtrack_url": null,
"license": null,
"summary": "Package for counting messages from Facebook Messenger",
"version": "0.5.1",
"project_urls": {
"Code": "https://github.com/KMChris/messenger-counter",
"Documentation": "https://messenger-counter.mizgala.pl/",
"Download": "https://pypi.org/project/messenger-counter/",
"Homepage": "https://github.com/KMChris/messenger-counter",
"Issue Tracker": "https://github.com/KMChris/messenger-counter/issues"
},
"split_keywords": [
"chart",
"count",
"counter",
"facebook",
"messages",
"messenger",
"statistics",
"stats"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3d3c2575c4f00450445acd6a29ae13e70871eff2dbc47663056eb4d88403f57e",
"md5": "5c7cdacbcf108403de91268b11917c68",
"sha256": "e484c1155ef3da63e9022313bf0c5bbd90d6a29a39bfd438278b6761c8813518"
},
"downloads": -1,
"filename": "messenger_counter-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c7cdacbcf108403de91268b11917c68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8969,
"upload_time": "2023-12-04T19:38:47",
"upload_time_iso_8601": "2023-12-04T19:38:47.211524Z",
"url": "https://files.pythonhosted.org/packages/3d/3c/2575c4f00450445acd6a29ae13e70871eff2dbc47663056eb4d88403f57e/messenger_counter-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7965d8cf7960e86483b132876059d8db2c54f21e7e5c255b10c9767e01f23167",
"md5": "7d04eb0a715b6c4a7bec53f962a3b5e3",
"sha256": "f91443a015e5983306d2bfc06060ef8bf58a6f6c0df85fee1f54590a7416e2d7"
},
"downloads": -1,
"filename": "messenger_counter-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "7d04eb0a715b6c4a7bec53f962a3b5e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9181,
"upload_time": "2023-12-04T19:38:49",
"upload_time_iso_8601": "2023-12-04T19:38:49.184681Z",
"url": "https://files.pythonhosted.org/packages/79/65/d8cf7960e86483b132876059d8db2c54f21e7e5c255b10c9767e01f23167/messenger_counter-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 19:38:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "KMChris",
"github_project": "messenger-counter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "messenger-counter"
}
JSON
