mirror of
https://github.com/Xevion/tumble.git
synced 2025-12-05 23:16:45 -06:00
create README
This commit is contained in:
31
README.md
Normal file
31
README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# tumble
|
||||
|
||||
Scrape videos and images from Tumblr with a simple commandline tool
|
||||
|
||||
## About
|
||||
|
||||
`tumble` is a very simple application for scraping media off of Tumblr.
|
||||
|
||||
Scraping a Tumblr blog into a self contained folder is extremely easy, and only requires one command (as it should).
|
||||
|
||||
## Setup
|
||||
|
||||
- Ensure that you have a working Python installation, and if you want to use one, enter a virtual environment.
|
||||
|
||||
- Clone the repository using `git clone`.
|
||||
|
||||
- `cd` into the repository root and then install the module using `pip install .`
|
||||
|
||||
- Using `pip` to install allows easy uninstalls (`pip uninstall tumble`) later on. Installing without pip or a
|
||||
dedicated package manager may require you to manually delete the module's files later on.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
Usage:
|
||||
tumble [blog_id]...
|
||||
|
||||
Options:
|
||||
-h -help Show this screen.
|
||||
--version Show version.
|
||||
```
|
||||
Reference in New Issue
Block a user