mirror/maigret
1
0
Fork 0
mirror of https://github.com/soxoj/maigret.git synced 2026-05-07 06:24:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
soxoj
2021-03-15 00:26:29 +03:00
committed by GitHub
parent 6058a4b70c
commit ac9cfe7885
1 changed files with 26 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+26 -8
View File
@@ -29,28 +29,46 @@ Currently supported more than 2000 sites ([full list](./sites.md)), by default s
## Installation
You can run Maigret in the cloud or install it on your machine.
[![Open in Cloud Shell](https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [![Run on Repl.it](https://user-images.githubusercontent.com/27065646/92304596-bf719b00-ef7f-11ea-987f-2c1f3c323088.png)](https://repl.it/github/soxoj/maigret)
**NOTE**: Python 3.6 or higher and pip is required.
**Python 3.8 is recommended.**
### Package installing
```bash
# install from pypi
$ pip3 install maigret
pip3 install maigret
# or clone and install manually
$ git clone https://github.com/soxoj/maigret && cd maigret
$ pip3 install .
git clone https://github.com/soxoj/maigret && cd maigret
pip3 install .
```
### Cloning a repository
```bash
git clone https://github.com/soxoj/maigret && cd maigret
```
You can use your a free virtual machine, the repo will be automatically cloned:
[![Open in Cloud Shell](https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [![Run on Repl.it](https://user-images.githubusercontent.com/27065646/92304596-bf719b00-ef7f-11ea-987f-2c1f3c323088.png)](https://repl.it/github/soxoj/maigret)
```bash
pip3 install -r requirements.txt
```
## Using examples
```bash
maigret user
# for a cloned repo
./maigret.py user
# for a package
maigret user
```
Features:
```bash
# make HTML and PDF reports
maigret user --html --pdf