Maintain a Website. Includes link checker.
Project description
maintain-website-tool
A tool to make it simpler to maintain a website against the increasing entropy on the web.
This tool includes:
- A link checker
- A CLI Interface
- A visualization of the links on a website
Usage
$ python3 -m maintain-website-tool --help
usage: maintain-website-tool [-h] {link} ...
positional arguments:
{link}
link Tools to maintain the links on a website
optional arguments:
-h, --help show this help message and exit
This tool always outputs to stdout (with one exception at link check visualize
)
and often takes input from stdin or files. I try to follow UNIX and Linux command
line convention as much as possible and as often as possible.
link
Tool
This can be used to:
- Collect a list of all links on your website.
- Collect latency, status and errors for each link on your website.
- Format results as CSV, YAML and JSON
- Take the difference in status, latency and errors between two different checks of a website.
- Visualize the results as a PyVIS Graph with domains as vertices and links as edges.
How to check a website
$ echo "https://example.org" python3 -m maintain-website-tool link --format csv check - > example.org.csv
The link check
command executes a check starting with the websites it receives as a file either from stdin (as in this example) or through some filename. You can even execute checks of multiple sites by providing more than one URI to the check (seperated by newlines).
See python3 -m maintain-website-tool link check --help
for more information.
Usage
$ python3 -m maintain-website-tool link --help
usage: maintain-website-tool link [-h] [--format {csv,yaml,yml,json}] [--in-format {csv,yaml,yml,json}]
[--out-format {csv,yaml,yml,json}]
{check,sort,diff,visualize} ...
positional arguments:
{check,sort,diff,visualize}
check Check all the locations in the locations for their reachability, latency and status
sort Sort the results from check according to some options
diff Take the difference between two check results
visualize Visualize the results of a page as a graph stored in a static HTML.
optional arguments:
-h, --help show this help message and exit
--format {csv,yaml,yml,json}, -f {csv,yaml,yml,json}
Format to expect for input and output (is overwritten by in-format and out-format
--in-format {csv,yaml,yml,json}, -in-f {csv,yaml,yml,json}
Format to expect from input only
--out-format {csv,yaml,yml,json}, -out-f {csv,yaml,yml,json}
Format to use for output only
Contributing
I want to extend this into a multipurpose tool to help with the maintance of a website. If you have an idea for other tools to be added, create an issue here.
Social Coding
I'm a subscriber to the ideals and principles of Social Coding.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for maintain-website-tool-0.0.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4eec788f41ba3e7ad0139354ba84901eb08e8a72cce7e7c1b42ed46f340bdf4 |
|
MD5 | 43dbccf4244602ce65249dd2551bdf46 |
|
BLAKE2b-256 | d1e827e92f7f9c5f33ec7f42f55cf7ae8fedf1f16816b0b6e0dfedbf83e36812 |
Hashes for maintain_website_tool-0.0.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d33de18cd1dc9e8b459e7c7d013a40814b4dcd8da36e63392d3d18cc44b4927 |
|
MD5 | c13540062eaf74a6b6bc6b107fa42b2c |
|
BLAKE2b-256 | f0dbb5c7c79c087a4672a010c60920b52a70ad5af0c30249ffeaa1452805c919 |