qbit_manage/docs/Local-Installations.md
bobokun 27231150ec
4.1.1 (#528)
* 4.1.1-develop

* Updated docs

* chore(docs): Sync wiki to docs [skip-cd]

* chore(docs): Sync wiki to docs [skip-cd]

* Fixes #522

* (docs): automatically add Supported Version to README (#521)

* (docs): add version for qbit / qbit api to readme (#523)

(cherry picked from commit 37e560f7ef)

* (docs): automate supported versions for readme

(docs): readme updates

(chore): fix pre-commit increase_version

* (chore): automate supported version updates

---------

Co-authored-by: bakerboy448 <mailto:55419169+bakerboy448@users.noreply.github.com>

* Adds pre-commit hook to update-readme-version

* Bump actions/setup-python from 4 to 5 (#525)

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump actions/checkout from 3 to 4 (#526)

Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump peter-evans/create-pull-request from 4 to 6 (#527)

Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 4 to 6.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](https://github.com/peter-evans/create-pull-request/compare/v4...v6)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Dependabot to auto-update qbittorrent-api on master

* 4.1.1

* fixes pre-commit on github actions

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Actionbot <actions@github.com>
Co-authored-by: bakerboy448 <55419169+bakerboy448@users.noreply.github.com>
Co-authored-by: bakerboy448 <mailto:55419169+bakerboy448@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-04-07 21:33:15 -04:00

1 KiB

Local Installations

  • Requires python 3.8.1. Dependencies must be installed by running:

Navigate to the directory you'd liked to clone the repo into

Clone the repo

git clone https://github.com/StuffAnThings/qbit_manage

Install requirements

pip install -r requirements.txt

If there are issues installing dependencies try:

pip install -r requirements.txt --ignore-installed

Usage

To run the script in an interactive terminal run:

  • copy the config.yml.sample file to config.yml
  • Fill out the config file as outlined in the Config-Setup

Run the script -h to see a list of commands

python qbit_manage.py -h

Config

To choose the location of the YAML config file

python qbit_manage.py --config-file <path_to_config>

Log

To choose the location of the Log File

python qbit_manage.py --log-file <path_to_log>