Skip to content

Update README.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ibantel wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ Initialize a new project and first steps
mkdir new_project
cd new_project
tgscrape --verbose init . --api-id <int> --api-hash <str>
# enter phone number
# enter phone number (format +<int>)
# enter confirmation code that is send to your Telegram account
```
**Important**: authenticating with `tgscrape init` writes two files to your current working directory

- 'tgscrape.session' (a Telethon session file)
- '.tgscrape.proj' (a hiden file containing your API ID and hast)
- '.tgscrape.proj' (a hidden file containing your API ID and hast)

Make sure to not share these files with any third-party
Most importantly, **add them to your .gitignore**!
Expand Down Expand Up @@ -74,7 +74,7 @@ Use a virtual environment
# create a virtual environment
virtualenv venv
# activate virtual environment
. venv/bin/activate
. venv/bin/activate # on Windows, use: cd venv\Lib and "activate"
# install required packages
pip install -r requirements.txt
```
Expand All @@ -92,4 +92,4 @@ pip freeze > requirements.txt
## Credit

- developed using [`click`](https://palletsprojects.com/p/click/)
- not inspired by [`tgscrape`](https://github.com/logr4y/tgscrape), same name though (found out only later ¯\_(ツ)_/¯)
- not inspired by [`tgscrape`](https://github.com/logr4y/tgscrape), same name though (found out only later ¯\_(ツ)_/¯)