Skip to content

Commit

Permalink
Fixed images sources to correctly display README.md on PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
andylvua committed Jul 13, 2022
1 parent bd7ef61 commit c692270
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# BibaAndBoba
Python package for analyzing Telegram chats and finding correlations between people

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://choosealicense.com/licenses/mit/)
[![PyPI version](https://img.shields.io/pypi/v/BibaAndBoba)](https://pypi.org/project/BibaAndBoba/)
[![Sphinx 5.0.2](https://img.shields.io/badge/Sphinx-5.0.2-orange)](https://www.sphinx-doc.org/en/master/)

[![Python application](https://github.com/andylvua/BibaAndBoba/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/andylvua/BibaAndBoba/actions/workflows/python-app.yml)
[![Documentation Status](https://readthedocs.org/projects/bibaandboba/badge/?version=latest)](https://bibaandboba.readthedocs.io/en/latest/?badge=latest)

## BibaAndBoba
Python package for analyzing Telegram chats and finding correlations between people

## About

**BibaAndBoba** is a tool for analyzing files containing Telegram chat
Expand Down Expand Up @@ -70,19 +70,19 @@ possible.

Find the three dots menu, and select the `Export chat history` option:

<img src="BibaAndBoba/docs/assets/exporting-0.png" width="300">
<img src="https://raw.githubusercontent.com/andylvua/BibaAndBoba/main/BibaAndBoba/docs/assets/exporting-0.png" width="300">

2. **Configure chat export settings as shown below.**

- Disable the `Photos` option.
- Set `Size limit` to 500 MB.

<img src="BibaAndBoba/docs/assets/exporting-1.png" width="300">
<img src="https://raw.githubusercontent.com/andylvua/BibaAndBoba/main/BibaAndBoba/docs/assets/exporting-1.png" width="300">

- Set `Format` to `Machine-readable JSON`.
- Set `Path` to your desired export directory.

<img src="BibaAndBoba/docs/assets/exporting-2.png" width="300">
<img src="https://raw.githubusercontent.com/andylvua/BibaAndBoba/main/BibaAndBoba/docs/assets/exporting-2.png" width="300">

**Click** `Export` and wait for the export to finish.

Expand All @@ -101,7 +101,7 @@ Now we are ready to go.

Assuming you have the following project structure:

<img src="BibaAndBoba/docs/assets/project-structure.png" width="300">
<img src="https://raw.githubusercontent.com/andylvua/BibaAndBoba/main/BibaAndBoba/docs/assets/project-structure.png" width="300">

For example, you want to find words that `Pavlo` uses often. At the same
time, you know that the `Roma` hardly or not at all communicate with him - see [How to choose chats](#how-to-choose-chats).
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = BibaAndBoba
version = 1.1.1
version = 1.1.2
author = Andrew Yaroshevych
author_email = ayaroshlvua@gmail.com
description = Python package for analyzing Telegram chats and finding correlations between people
Expand Down

0 comments on commit c692270

Please sign in to comment.