pferd/README.md

41 lines
1006 B
Markdown
Raw Normal View History

2019-04-25 21:58:30 +02:00
# PFERD
**P**rogramm zum **F**lotten, **E**infachen **R**unterladen von **D**ateien
2019-04-25 13:48:58 +02:00
## Installation
2019-04-25 22:04:14 +02:00
Ensure that you have at least Python 3.7 installed (3.6 might also work, didn't
test it though).
2019-04-25 13:48:58 +02:00
2019-04-25 22:04:14 +02:00
To install PFERD or update your installation to the latest version, run this
wherever you want to install/have installed PFERD:
2019-04-25 13:48:58 +02:00
```
2019-09-22 13:56:41 +02:00
$ pip install git+https://github.com/Garmelon/PFERD@v1.1.8
2019-04-25 13:48:58 +02:00
```
The use of [venv](https://docs.python.org/3/library/venv.html) is recommended.
2019-04-25 21:30:02 +02:00
2019-04-25 22:04:14 +02:00
## Example setup
In this example, `python3` refers to at least Python 3.7.
2019-04-25 21:30:02 +02:00
A full example setup and initial use could look like:
```
$ mkdir Vorlesungen
$ cd Vorlesungen
$ python3 -m venv .
$ . bin/activate
2019-09-22 13:56:41 +02:00
$ pip install git+https://github.com/Garmelon/PFERD@v1.1.8
2019-04-25 21:30:02 +02:00
$ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/master/example_config.py
2019-04-25 21:57:04 +02:00
$ python3 example_config.py
2019-04-25 22:01:12 +02:00
$ deactivate
```
Subsequent runs of the program might look like:
```
$ cd Vorlesungen
$ . bin/activate
$ python3 example_config.py
$ deactivate
2019-04-25 21:30:02 +02:00
```