STRLCPY/maigret

Total 1 files

■ ■ ■ ■ ■ ■

README.md

		skipped 32 lines
33	33
34	34		Python 3.8 is recommended.
35	35
	36	+	### Package installing
36	37		```bash
37	38		# install from pypi
38		-	$ pip3 install maigret
	39	+	pip3 install maigret
39	40
40	41		# or clone and install manually
41		-	$ git clone https://github.com/soxoj/maigret && cd maigret
42		-	$ pip3 install .
	42	+	git clone https://github.com/soxoj/maigret && cd maigret
	43	+	pip3 install .
	44	+	```
	45	+
	46	+	### Cloning a repository
	47	+
	48	+	```bash
	49	+	git clone https://github.com/soxoj/maigret && cd maigret
	50	+	```
	51	+
	52	+	You can use your a free virtual machine, the repo will be automatically cloned:
	53	+
	54	+	[![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)
	55	+
	56	+	```bash
	57	+	pip3 install -r requirements.txt
43	58		```
44	59
45	60		## Using examples
46	61
47	62		```bash
	63	+	# for a cloned repo
	64	+	./maigret.py user
	65	+
	66	+	# for a package
48	67		maigret user
	68	+	```
49	69
	70	+	Features:
	71	+	```bash
50	72		# make HTML and PDF reports
51	73		maigret user --html --pdf
52	74
		skipped 37 lines