From 9ca316671f6bed06f491b52a737137a5eeda8ecd Mon Sep 17 00:00:00 2001 From: Vincent Agnano Date: Wed, 11 Dec 2019 10:47:55 +0100 Subject: [PATCH] readme instructions for virtualenv --- .gitignore | 2 ++ README.md | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index a65d046..025faa1 100755 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +/venv/ + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/README.md b/README.md index bc7b262..fb3f3b8 100755 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Getting Tweet-Toot working is pretty easy. Before you can install it, you're goi Once you have the above, just follow these steps: 1. Clone this repository. -2. Install the Python3 libraries `requests` and `beautifulsoup` mentioned in the `requirements.txt` file. +2. Install the Python3 libraries: `python3 -m venv venv`, then `source venv/bin/activate` and install dependencies `pip install -r requirements.txt`. 3. In `config.json`, update the following: - `tweets.source_account_url`: The source Twitter account. @@ -30,6 +30,8 @@ For example: ## How do I run it? Once it's all setup, just run the main file like this: +Activate the virtualenv you created on install (if it's not activated yet): `source venv/bin/activate` and run the script: + `python3 run.py` If all goes well, you'll see something like this: @@ -70,4 +72,4 @@ The container has support for sending logs to Papertrail. Just add your authenti - Mastodon instance admins are people too. Don't toot-blast your instance and make life harder for them. - When configuring your bot, ensure you clearly display an account where you can be reached in case of issues. -Have fun :) \ No newline at end of file +Have fun :)