From fbb7513f15a48a91cf53d480569b1eacf6654ba4 Mon Sep 17 00:00:00 2001 From: tassoman Date: Thu, 7 Dec 2023 08:44:45 +0100 Subject: [PATCH] fixing pre-commit --- .pre-commit-config.yaml | 1 - README.md | 16 ++++++++++++---- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index bf61f2f..6c32a44 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,7 +15,6 @@ repos: entry: pylint language: system types: [python] - files: feed_bot.py # args: # [ # "-rn", # Only display messages diff --git a/README.md b/README.md index b4e4202..c4800e6 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,9 @@ Please, follow this instructions once, before starting: - Visit the page: `https://your.misskey.instance/settings/api` - Create a new API-key having at minimum `notes:write` privilege. -### Prepare a Python virtual environment +### Prepare a Python virtual environment -Please use python3. In latest GNU/Linux distros, it's already in as default. Otherwise you'll need `python3-venv` package with dependencies. +Please use python3. In latest GNU/Linux distros, it's already in as default. Otherwise you'll need `python3-venv` package with dependencies. 1. `git clone` this repository, to get the source code, or download the zip file 2. `python -m venv .venv` Python sandboxed enviroment creation @@ -38,7 +38,7 @@ Now you installed the software, you need a small amount of configuration. ### Fill the bot with RSS feed -First of all, put the RSS Feed source URLS into the file `sources.txt`, line by line. +First of all, put the RSS Feed source URLS into the file `sources.txt`, line by line. ### Environment variables @@ -65,7 +65,7 @@ You probably want to run it detached from the console by using `nohup` or runnin The software has ability to avoid multiple concurrent runs. -## Stop! +## Stop! To stop it, just press `CTRL+C` in the console. @@ -74,3 +74,11 @@ To exit the Python environment type: `deactivate`. You're aware of activation be ## Upgrade It's super easy, just Stop! Then `git pull` to check for updates. Then `pip-review -a` to update the libraries. Needs a restart to get things done. + +## Development + +If you plan to contribute, please run this command, after installation noted before. + +```bash +pre-commmit install +```