Make a package

.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,5 @@
+wclone.egg-info
+build
+*__pycache__
+.vscode
+dist

README.md

@@ -1,13 +1,79 @@
 # Basic website cloner
 
 **Description:**
+
 * This script is a basic website cloner that downloads all the files from a website and saves them in a folder.
 * It works by scraping all the links on the page, save them locally, and replace them with the local path.
 
-**Usage:**
-```bash
-python3 website_cloner.py <url>
+## Installation
+
+## From [pypi](pypi.org).
+
+```sh
+pip3 install wclone
+```
+
+## From source
+
+```sh
+git clone https://github.com/Simatwa/website-clone.git
+cd website-cloner
+bash install.sh
+```
+
+## Usage
+
+```sh
+$ wclone <url>
 ```
 
 **More info:**
-* In order to use the tor network, you need to download the [tor package](https://www.torproject.org/dist/torbrowser/11.0.9/tor-win32-0.4.6.10.zip) and start the tor service.
+
+* In order to use the tor network, you need to download the [tor package](https://www.torproject.org/dist/torbrowser/11.0.9/tor-win32-0.4.6.10.zip) and start the tor service.
+
+<details>
+
+<summary>
+
+> For further info run `$ wclone --help`
+
+</summary>
+
+```
+ usage: wclone [-h] [-v] [-tp PROXY]
+              [-o FOLDER] [-w PATH]
+              [--use-tor]
+              host
+
+Basic website cloner written in Python
+
+positional arguments:                  host         URL pointing to a
+               website               
+options:
+  -h, --help   show this help
+               message and exit
+  -v, ---version
+               show program's
+               version number and
+               exit
+  -tp PROXY, --tor-proxy PROXY
+               Proxy server url
+               without schema -
+               localhost:9050
+  -o FOLDER, --output FOLDER
+               Folder for saving
+               contents - host
+  -w PATH, --workspace PATH
+               Directory for saving
+               contents - /data/dat
+               a/com.termux/files/h
+               ome/temp
+  --use-tor    Use tor proxy -
+               False
+```
+</details>
+
+
+
+
+

install.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/bash
+pip3 install .
+wclone -h