<div style="text-align:center"><img src="https://raw.githubusercontent.com/urlstechie/urlchecker-python/master/docs/urlstechie.png"/></div>
[](https://travis-ci.com/urlstechie/urlchecker-python) [](https://urlchecker-python.readthedocs.io/en/latest/?badge=latest) [](https://codecov.io/gh/urlstechie/urlchecker-python) [](https://www.python.org/doc/versions/) [](https://www.codefactor.io/repository/github/urlstechie/urlchecker-python)  [](https://pepy.tech/project/urlchecker) [](https://github.com/urlstechie/urlchecker-python/blob/master/LICENSE)
# urlchecker-python
This is a python module to collect urls over static files (code and documentation)
and then test for and report broken links. If you are interesting in using
this as a GitHub action, see [urlchecker-action](https://github.com/urlstechie/urlchecker-action). There are also container
bases available on [quay.io/urlstechie/urlchecker](https://quay.io/repository/urlstechie/urlchecker?tab=tags). As of version
0.0.26, we use multiprocessing so the checks run a lot faster, and you can set `URLCHECKER_WORKERS` to change the number of workers
(defaults to 9). If you don't want multiprocessing, use version 0.0.25 or earlier.
## Module Documentation
A detailed documentation of the code is available under [urlchecker-python.readthedocs.io](https://urlchecker-python.readthedocs.io/en/latest/)
## Usage
### Install
You can install the urlchecker from [pypi](https://pypi.org/project/urlchecker).
Before you do, it's recommended to install fake-useragent from:
```bash
pip install git+https://github.com/danger89/fake-useragent.git
```
And then urlchecker:
```bash
$ pip install urlchecker
```
or install from the repository directly:
```bash
$ git clone https://github.com/urlstechie/urlchecker-python.git
$ cd urlchecker-python
$ python setup.py install
```
Installation will place a binary, `urlchecker` in your Python path.
```bash
$ which urlchecker
/home/vanessa/anaconda3/bin/urlchecker
```
### Check Local Folder
Your most likely use case will be to check a local directory with static files (documentation or code)
for files. In this case, you can use urlchecker check:
```bash
$ urlchecker check --help
```
```console
usage: urlchecker check [-h] [-b BRANCH] [--subfolder SUBFOLDER] [--cleanup] [--serial] [--no-check-certs]
[--force-pass] [--no-print] [--verbose] [--file-types FILE_TYPES] [--files FILES]
[--exclude-urls EXCLUDE_URLS] [--exclude-patterns EXCLUDE_PATTERNS]
[--exclude-files EXCLUDE_FILES] [--save SAVE] [--retry-count RETRY_COUNT] [--timeout TIMEOUT]
path
positional arguments:
path the local path or GitHub repository to clone and check
options:
-h, --help show this help message and exit
-b BRANCH, --branch BRANCH
if cloning, specify a branch to use (defaults to main)
--subfolder SUBFOLDER
relative subfolder path within path (if not specified, we use root)
--cleanup remove root folder after checking (defaults to False, no cleaup)
--serial run checks in serial (no multiprocess)
--no-check-certs Allow urls to validate that fail certificate checks
--force-pass force successful pass (return code 0) regardless of result
--no-print Skip printing results to the screen (defaults to printing to console).
--verbose Print file names for failed urls in addition to the urls.
--file-types FILE_TYPES
comma separated list of file extensions to check (defaults to .md,.py)
--files FILES comma separated list of exact files or patterns to check.
--exclude-urls EXCLUDE_URLS
comma separated links to exclude (no spaces)
--exclude-patterns EXCLUDE_PATTERNS
comma separated list of patterns to exclude (no spaces)
--exclude-files EXCLUDE_FILES
comma separated list of files and patterns to exclude (no spaces)
--save SAVE Path to a csv file to save results to.
--retry-count RETRY_COUNT
retry count upon failure (defaults to 2, one retry).
--timeout TIMEOUT timeout (seconds) to provide to the requests library (defaults to 5)
```
You have a lot of flexibility to define patterns of urls or files to skip,
along with the number of retries or timeout (seconds). The most basic usage will
check an entire directory. Let's clone and check the urlchecker action:
```bash
$ git clone https://github.com/urlstechie/urlchecker-action.git
$ cd urchecker-action
```
and run the simplest command to check the present working directory (.).
```bash
$ urlchecker check .
original path: .
final path: /tmp/urlchecker-action
subfolder: None
branch: master
cleanup: False
file types: ['.md', '.py']
files: []
print all: True
urls excluded: []
url patterns excluded: []
file patterns excluded: []
force pass: False
retry count: 2
save: None
timeout: 5
/tmp/urlchecker-action/README.md
--------------------------------
https://github.com/urlstechie/urlchecker-action/blob/master/LICENSE
https://github.com/r-hub/docs/blob/bc1eac71206f7cb96ca00148dcf3b46c6d25ada4/.github/workflows/pr.yml
https://img.shields.io/static/v1?label=Marketplace&message=urlchecker-action&color=blue?style=flat&logo=github
https://github.com/rseng/awesome-rseng
https://github.com/rseng/awesome-rseng/blob/5f5cb78f8392cf10aec2f3952b305ae9611029c2/.github/workflows/urlchecker.yml
https://github.com/HPC-buildtest/buildtest-framework/actions?query=workflow%3A%22Check+URLs%22
https://www.codefactor.io/repository/github/urlstechie/urlchecker-action/badge
https://github.com/berlin-hack-and-tell/berlinhackandtell.rocks
https://github.com/urlstechie/urlchecker-action/issues
https://github.com/USRSE/usrse.github.io
https://github.com/berlin-hack-and-tell/berlinhackandtell.rocks/actions?query=workflow%3ACommands
https://github.com/USRSE/usrse.github.io/blob/abcbed5f5703e0d46edb9e8850eea8bb623e3c1c/.github/workflows/urlchecker.yml
https://github.com/urlstechie/urlchecker-action/releases
https://img.shields.io/badge/license-MIT-brightgreen
https://github.com/r-hub/docs/actions?query=workflow%3ACommands
https://github.com/rseng/awesome-rseng/actions?query=workflow%3AURLChecker
https://github.com/buildtesters/buildtest
https://github.com/r-hub/docs
https://www.codefactor.io/repository/github/urlstechie/urlchecker-action
https://github.com/urlstechie/URLs-checker-test-repo
https://github.com/marketplace/actions/urlchecker-action
https://github.com/actions/checkout
https://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2
https://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2
https://github.com/USRSE/usrse.github.io/actions?query=workflow%3A%22Check+URLs%22
https://github.com/SuperKogito/Voice-based-gender-recognition/issues
https://github.com/buildtesters/buildtest/blob/v0.9.1/.github/workflows/urlchecker.yml
https://github.com/berlin-hack-and-tell/berlinhackandtell.rocks/blob/master/.github/workflows/urlchecker-pr-label.yml
/tmp/urlchecker-action/examples/README.md
-----------------------------------------
https://github.com/urlstechie/urlchecker-action/releases
https://github.com/urlstechie/urlchecker-action/issues
https://help.github.com/en/actions/reference/events-that-trigger-workflows
Done. The following urls did not pass:
https://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2
```
The url that didn't pass above is an example parameter for the library! Let's add
a simple pattern to exclude it.
```bash
$ urlchecker check --exclude-pattern SuperKogito .
original path: .
final path: /tmp/urlchecker-action
subfolder: None
branch: master
cleanup: False
file types: ['.md', '.py']
files: []
print all: True
urls excluded: []
url patterns excluded: ['SuperKogito']
file patterns excluded: []
force pass: False
retry count: 2
save: None
timeout: 5
/tmp/urlchecker-action/README.md
--------------------------------
https://github.com/urlstechie/urlchecker-action/blob/master/LICENSE
https://github.com/urlstechie/urlchecker-action/issues
https://github.com/rseng/awesome-rseng/actions?query=workflow%3AURLChecker
https://github.com/USRSE/usrse.github.io/actions?query=workflow%3A%22Check+URLs%22
https://github.com/actions/checkout
https://github.com/USRSE/usrse.github.io/blob/abcbed5f5703e0d46edb9e8850eea8bb623e3c1c/.github/workflows/urlchecker.yml
https://github.com/r-hub/docs/blob/bc1eac71206f7cb96ca00148dcf3b46c6d25ada4/.github/workflows/pr.yml
https://github.com/berlin-hack-and-tell/berlinhackandtell.rocks/blob/master/.github/workflows/urlchecker-pr-label.yml
https://github.com/rseng/awesome-rseng
https://www.codefactor.io/repository/github/urlstechie/urlchecker-action/badge
https://github.com/urlstechie/URLs-checker-test-repo
https://www.codefactor.io/repository/github/urlstechie/urlchecker-action
https://github.com/r-hub/docs
https://github.com/berlin-hack-and-tell/berlinhackandtell.rocks
https://github.com/buildtesters/buildtest
https://img.shields.io/badge/license-MIT-brightgreen
https://github.com/urlstechie/urlchecker-action/releases
https://github.com/marketplace/actions/urlchecker-action
https://img.shields.io/static/v1?label=Marketplace&message=urlchecker-action&color=blue?style=flat&logo=github
https://github.com/r-hub/docs/actions?query=workflow%3ACommands
https://github.com/HPC-buildtest/buildtest-framework/actions?query=workflow%3A%22Check+URLs%22
https://github.com/buildtesters/buildtest/blob/v0.9.1/.github/workflows/urlchecker.yml
https://github.com/berlin-hack-and-tell/berlinhackandtell.rocks/actions?query=workflow%3ACommands
https://github.com/USRSE/usrse.github.io
https://github.com/rseng/awesome-rseng/blob/5f5cb78f8392cf10aec2f3952b305ae9611029c2/.github/workflows/urlchecker.yml
/tmp/urlchecker-action/examples/README.md
-----------------------------------------
https://help.github.com/en/actions/reference/events-that-trigger-workflows
https://github.com/urlstechie/urlchecker-action/issues
https://github.com/urlstechie/urlchecker-action/releases
Done. All URLS passed.
```
We can also filter by file types. If we want to do this (for example, to only check different file
types) we might do any of the following:
```bash
# Check only html files
urlchecker check --file-types *.html .
# Check hidden flies
urlchecker check --file-types ".*" .
# Check hidden files and html files
urlchecker check --file-types ".*,*.html" .
```
**Note that while some patterns will work without quotes, it's recommended for most**
to use them because if the shell expands any part of the pattern, it will not work as
expected. By default, the urlchecker checks python and markdown. If a multiprocessing workers has an error,
you can also add `--serial` to run in serial and test. The run will be slower, but it's useful for debugging.
```bash
$ urlchecker check . --files "content/docs/hacking/contributing/documentation/index.md" --serial
```
### Check GitHub Repository
But wouldn't it be easier to not have to clone the repository first?
Of course! We can specify a GitHub url instead, and add `--cleanup`
if we want to clean up the folder after.
```bash
$ urlchecker check https://github.com/SuperKogito/SuperKogito.github.io.git
```
If you specify any arguments for a white list (or any kind of expected list) make
sure that you provide a comma separated list *without any spaces*
```bash
$ urlchecker check --exclude-files=README.md,_config.yml
```
### Save Results
If you want to save your results to file, perhaps for some kind of record or
other data analysis, you can provide the `--save` argument:
```bash
$ urlchecker check --save results.csv .
```
The file that you save to will include a comma separated value tabular listing
of the urls, and their result. The result options are "passed" and "failed"
and the default header is `URL,RESULT`. All of these defaults are exposed
if you want to change them (e.g., using a tab separator or a different header)
if you call the function from within Python. Here is an example of the default file
produced, which should satisfy most use cases:
```
URL,RESULT
https://github.com/SuperKogito,passed
https://www.google.com/,passed
https://github.com/SuperKogito/Voice-based-gender-recognition/issues,passed
https://github.com/SuperKogito/Voice-based-gender-recognition,passed
https://github.com/SuperKogito/spafe/issues/4,passed
https://github.com/SuperKogito/Voice-based-gender-recognition/issues/2,passed
https://github.com/SuperKogito/spafe/issues/5,passed
https://github.com/SuperKogito/URLs-checker/blob/master/README.md,passed
https://img.shields.io/,passed
https://github.com/SuperKogito/spafe/,passed
https://github.com/SuperKogito/spafe/issues/3,passed
https://www.google.com/,passed
https://github.com/SuperKogito,passed
https://github.com/SuperKogito/spafe/issues/8,passed
https://github.com/SuperKogito/spafe/issues/7,passed
https://github.com/SuperKogito/Voice-based-gender-recognition/issues/1,passed
https://github.com/SuperKogito/spafe/issues,passed
https://github.com/SuperKogito/URLs-checker/issues,passed
https://github.com/SuperKogito/spafe/issues/2,passed
https://github.com/SuperKogito/URLs-checker,passed
https://github.com/SuperKogito/spafe/issues/6,passed
https://github.com/SuperKogito/spafe/issues/1,passed
https://github.com/SuperKogito/URLs-checker/README.md,failed
https://github.com/SuperKogito/URLs-checker/issues/3,failed
https://none.html,failed
https://github.com/SuperKogito/URLs-checker/issues/2,failed
https://github.com/SuperKogito/URLs-checker/README.md,failed
https://github.com/SuperKogito/URLs-checker/issues/1,failed
https://github.com/SuperKogito/URLs-checker/issues/4,failed
```
### Usage from Python
#### Checking a Path
If you want to check a list of urls outside of the provided client, this is fairly easy to do!
Let's say we have a path, our present working directory, and we want to check
.py and .md files (the default)
```python
from urlchecker.core.check import UrlChecker
import os
path = os.getcwd()
checker = UrlChecker(path)
# UrlChecker:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python
```
And of course you can provide more substantial arguments to derive the original
file list:
```python
checker = UrlChecker(
path=path,
file_types=[".md", ".py", ".rst"],
include_patterns=[],
exclude_files=["README.md", "LICENSE"],
print_all=True,
)
```
I can then run the checker like this:
```python
checker.run()
```
Or with more customization of excluded urls:
```python
checker.run(
exclude_urls=exclude_urls,
exclude_patterns=exclude_patterns,
retry_count=3,
timeout=5,
)
```
You'll get the results object returned, which is also available at `checker.results`,
a simple dictionary with "passed" and "failed" keys to show passes and fails across
all files.
```python
{'passed': ['https://github.com/SuperKogito/spafe/issues/4',
'http://shachi.org/resources',
'https://superkogito.github.io/blog/SpectralLeakageWindowing.html',
'https://superkogito.github.io/figures/fig4.html',
'https://github.com/urlstechie/urlchecker-test-repo',
'https://www.google.com/',
...
'https://github.com/SuperKogito',
'https://img.shields.io/',
'https://www.google.com/',
'https://docs.python.org/2'],
'failed': ['https://github.com/urlstechie/urlschecker-python/tree/master',
'https://github.com/SuperKogito/Voice-based-gender-recognition,passed',
'https://github.com/SuperKogito/URLs-checker/README.md',
...
'https://superkogito.github.io/tables',
'https://github.com/SuperKogito/URLs-checker/issues/2',
'https://github.com/SuperKogito/URLs-checker/README.md',
'https://github.com/SuperKogito/URLs-checker/issues/4',
'https://github.com/SuperKogito/URLs-checker/issues/3',
'https://github.com/SuperKogito/URLs-checker/issues/1',
'https://none.html']}
```
You can look at `checker.checks`, which is a dictionary of result objects,
organized by the filename:
```python
for file_name, result in checker.checks.items():
print()
print(result)
print("Total Results: %s " % result.count)
print("Total Failed: %s" % len(result.failed))
print("Total Passed: %s" % len(result.passed))
...
UrlCheck:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python/tests/test_files/sample_test_file.md
Total Results: 26
Total Failed: 6
Total Passed: 20
UrlCheck:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python/.pytest_cache/README.md
Total Results: 1
Total Failed: 0
Total Passed: 1
UrlCheck:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python/.eggs/pytest_runner-5.2-py3.7.egg/ptr.py
Total Results: 0
Total Failed: 0
Total Passed: 0
UrlCheck:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python/docs/source/conf.py
Total Results: 3
Total Failed: 0
Total Passed: 3
```
For any result object, you can print the list of passed, falied, white listed,
or all the urls.
```python
result.all
['https://www.sphinx-doc.org/en/master/usage/configuration.html',
'https://docs.python.org/3',
'https://docs.python.org/2']
result.failed
[]
result.exclude
[]
result.passed
['https://www.sphinx-doc.org/en/master/usage/configuration.html',
'https://docs.python.org/3',
'https://docs.python.org/2']
result.count
3
```
#### Checking a List of URls
If you start with a list of urls you want to check, you can do that too!
```python
from urlchecker.core.urlproc import UrlCheckResult
urls = ['https://www.github.com', "https://github.com", "https://banana-pudding-doesnt-exist.com"]
# Instantiate an empty checker to extract urls
checker = UrlCheckResult()
File name None is undefined or does not exist, skipping extraction.
```
If you provied a file name, the urls would be extracted for you.
```python
checker = UrlCheckResult(
file_name=file_name,
exclude_patterns=exclude_patterns,
exclude_urls=exclude_urls,
print_all=self.print_all,
)
```
or you can provide all the parameters without the filename:
```python
checker = UrlCheckResult(
exclude_patterns=exclude_patterns,
exclude_urls=exclude_urls,
print_all=self.print_all,
)
```
If you don't provide the file_name to check urls, you can give the urls
you defined previously directly to the `check_urls` function:
```python
checker.check_urls(urls)
https://www.github.com
https://github.com
HTTPSConnectionPool(host='banana-pudding-doesnt-exist.com', port=443): Max retries exceeded with url: / (Caused by NewConnectionError('<urllib3.connection.VerifiedHTTPSConnection object at 0x7f989abdfa10>: Failed to establish a new connection: [Errno -2] Name or service not known'))
https://banana-pudding-doesnt-exist.com
```
And of course you can specify a timeout and retry:
```python
checker.check_urls(urls, retry_count=retry_count, timeout=timeout)
```
After you run the checker you can get all the urls, the passed,
and failed sets:
```python
checker.failed
['https://banana-pudding-doesnt-exist.com']
checker.passed
['https://www.github.com', 'https://github.com']
checker.all
['https://www.github.com',
'https://github.com',
'https://banana-pudding-doesnt-exist.com']
checker.all
['https://www.github.com',
'https://github.com',
'https://banana-pudding-doesnt-exist.com']
checker.count
3
```
If you have any questions, please don't hesitate to [open an issue](https://github.com/urlstechie/urlchecker-python).
### Docker
A Docker container is provided if you want to build a base container with urlchecker,
meaning that you don't need to install it on your host. You can build the container as
follows:
```bash
docker build -t urlchecker .
```
And then the entrypoint will expose the urlchecker.
```bash
docker run -it urlschecker
```
## Development
### Organization
The module is organized as follows:
```
├── client # command line client
├── main # functions for supported integrations (e.g., GitHub)
├── core # core file and url processing tools
└── version.py # package and versioning
```
In the "client" folder, for example, the commands that are exposed for the client
(e.g., check) would named accordingly, e.g., `client/check.py`.
Functions for Github are be provided in `main/github.py`. This organization should
be fairly straight forward to always find what you are looking for.
### Drivers
To test more difficult urls, we use a web driver, and you can choose between:
- [Chrome Driver](https://chromedriver.chromium.org/downloads)
- [Gecko Driver](https://github.com/mozilla/geckodriver/releases) (firefox)
both to be used with selenium. This driver is optional, but will come by default with our action. To install
it, you can download the driver at either of the links above and ensure you install selenium:
```bash
$ pip install urlchecker[selenium]
```
and either:
1. Add it directly to your path
2. Export the directory where it lives as `URLCHECKER_DRIVERS_PATH`
3. Put it in the root of the urlchecker clone (it will be looked for here)
## Support
If you need help, or want to suggest a project for the organization,
please [open an issue](https://github.com/urlstechie/urlchecker-python)
Raw data
{
"_id": null,
"home_page": "http://www.github.com/urlstechie/urlchecker-python",
"name": "urlchecker",
"maintainer": "Ayoub Malek, Vanessa Sochat",
"docs_url": null,
"requires_python": "",
"maintainer_email": "superkogito@gmail.com, vsochat@stanford.edu",
"keywords": "urls,static checking,checking,validation",
"author": "Ayoub Malek, Vanessa Sochat",
"author_email": "superkogito@gmail.com, vsochat@stanford.edu",
"download_url": "https://files.pythonhosted.org/packages/97/11/b87b3e014d93bfb7dc288fe907fefdf401bf2a35494cdaef9438d2e701e5/urlchecker-0.0.35.tar.gz",
"platform": null,
"description": "<div style=\"text-align:center\"><img src=\"https://raw.githubusercontent.com/urlstechie/urlchecker-python/master/docs/urlstechie.png\"/></div>\n\n[](https://travis-ci.com/urlstechie/urlchecker-python) [](https://urlchecker-python.readthedocs.io/en/latest/?badge=latest) [](https://codecov.io/gh/urlstechie/urlchecker-python) [](https://www.python.org/doc/versions/) [](https://www.codefactor.io/repository/github/urlstechie/urlchecker-python)  [](https://pepy.tech/project/urlchecker) [](https://github.com/urlstechie/urlchecker-python/blob/master/LICENSE)\n\n\n# urlchecker-python\n\nThis is a python module to collect urls over static files (code and documentation)\nand then test for and report broken links. If you are interesting in using\nthis as a GitHub action, see [urlchecker-action](https://github.com/urlstechie/urlchecker-action). There are also container\nbases available on [quay.io/urlstechie/urlchecker](https://quay.io/repository/urlstechie/urlchecker?tab=tags). As of version\n0.0.26, we use multiprocessing so the checks run a lot faster, and you can set `URLCHECKER_WORKERS` to change the number of workers\n(defaults to 9). If you don't want multiprocessing, use version 0.0.25 or earlier.\n\n## Module Documentation\n\nA detailed documentation of the code is available under [urlchecker-python.readthedocs.io](https://urlchecker-python.readthedocs.io/en/latest/)\n\n## Usage\n\n### Install\n\nYou can install the urlchecker from [pypi](https://pypi.org/project/urlchecker).\nBefore you do, it's recommended to install fake-useragent from:\n\n```bash\npip install git+https://github.com/danger89/fake-useragent.git\n```\n\nAnd then urlchecker:\n\n```bash\n$ pip install urlchecker\n```\n\nor install from the repository directly:\n\n```bash\n$ git clone https://github.com/urlstechie/urlchecker-python.git\n$ cd urlchecker-python\n$ python setup.py install\n```\n\nInstallation will place a binary, `urlchecker` in your Python path.\n\n```bash\n$ which urlchecker\n/home/vanessa/anaconda3/bin/urlchecker\n```\n\n\n### Check Local Folder\n\nYour most likely use case will be to check a local directory with static files (documentation or code)\nfor files. In this case, you can use urlchecker check:\n\n```bash\n$ urlchecker check --help\n```\n```console\nusage: urlchecker check [-h] [-b BRANCH] [--subfolder SUBFOLDER] [--cleanup] [--serial] [--no-check-certs]\n [--force-pass] [--no-print] [--verbose] [--file-types FILE_TYPES] [--files FILES]\n [--exclude-urls EXCLUDE_URLS] [--exclude-patterns EXCLUDE_PATTERNS]\n [--exclude-files EXCLUDE_FILES] [--save SAVE] [--retry-count RETRY_COUNT] [--timeout TIMEOUT]\n path\n\npositional arguments:\n path the local path or GitHub repository to clone and check\n\noptions:\n -h, --help show this help message and exit\n -b BRANCH, --branch BRANCH\n if cloning, specify a branch to use (defaults to main)\n --subfolder SUBFOLDER\n relative subfolder path within path (if not specified, we use root)\n --cleanup remove root folder after checking (defaults to False, no cleaup)\n --serial run checks in serial (no multiprocess)\n --no-check-certs Allow urls to validate that fail certificate checks\n --force-pass force successful pass (return code 0) regardless of result\n --no-print Skip printing results to the screen (defaults to printing to console).\n --verbose Print file names for failed urls in addition to the urls.\n --file-types FILE_TYPES\n comma separated list of file extensions to check (defaults to .md,.py)\n --files FILES comma separated list of exact files or patterns to check.\n --exclude-urls EXCLUDE_URLS\n comma separated links to exclude (no spaces)\n --exclude-patterns EXCLUDE_PATTERNS\n comma separated list of patterns to exclude (no spaces)\n --exclude-files EXCLUDE_FILES\n comma separated list of files and patterns to exclude (no spaces)\n --save SAVE Path to a csv file to save results to.\n --retry-count RETRY_COUNT\n retry count upon failure (defaults to 2, one retry).\n --timeout TIMEOUT timeout (seconds) to provide to the requests library (defaults to 5)\n```\n\nYou have a lot of flexibility to define patterns of urls or files to skip,\nalong with the number of retries or timeout (seconds). The most basic usage will\ncheck an entire directory. Let's clone and check the urlchecker action:\n\n```bash\n$ git clone https://github.com/urlstechie/urlchecker-action.git\n$ cd urchecker-action\n```\n\nand run the simplest command to check the present working directory (.).\n\n```bash\n$ urlchecker check .\n original path: .\n final path: /tmp/urlchecker-action\n subfolder: None\n branch: master\n cleanup: False\n file types: ['.md', '.py']\n files: []\n print all: True\n urls excluded: []\n url patterns excluded: []\n file patterns excluded: []\n force pass: False\n retry count: 2\n save: None\n timeout: 5\n\n /tmp/urlchecker-action/README.md \n --------------------------------\nhttps://github.com/urlstechie/urlchecker-action/blob/master/LICENSE\nhttps://github.com/r-hub/docs/blob/bc1eac71206f7cb96ca00148dcf3b46c6d25ada4/.github/workflows/pr.yml\nhttps://img.shields.io/static/v1?label=Marketplace&message=urlchecker-action&color=blue?style=flat&logo=github\nhttps://github.com/rseng/awesome-rseng\nhttps://github.com/rseng/awesome-rseng/blob/5f5cb78f8392cf10aec2f3952b305ae9611029c2/.github/workflows/urlchecker.yml\nhttps://github.com/HPC-buildtest/buildtest-framework/actions?query=workflow%3A%22Check+URLs%22\nhttps://www.codefactor.io/repository/github/urlstechie/urlchecker-action/badge\nhttps://github.com/berlin-hack-and-tell/berlinhackandtell.rocks\nhttps://github.com/urlstechie/urlchecker-action/issues\nhttps://github.com/USRSE/usrse.github.io\nhttps://github.com/berlin-hack-and-tell/berlinhackandtell.rocks/actions?query=workflow%3ACommands\nhttps://github.com/USRSE/usrse.github.io/blob/abcbed5f5703e0d46edb9e8850eea8bb623e3c1c/.github/workflows/urlchecker.yml\nhttps://github.com/urlstechie/urlchecker-action/releases\nhttps://img.shields.io/badge/license-MIT-brightgreen\nhttps://github.com/r-hub/docs/actions?query=workflow%3ACommands\nhttps://github.com/rseng/awesome-rseng/actions?query=workflow%3AURLChecker\nhttps://github.com/buildtesters/buildtest\nhttps://github.com/r-hub/docs\nhttps://www.codefactor.io/repository/github/urlstechie/urlchecker-action\nhttps://github.com/urlstechie/URLs-checker-test-repo\nhttps://github.com/marketplace/actions/urlchecker-action\nhttps://github.com/actions/checkout\nhttps://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2\nhttps://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2\nhttps://github.com/USRSE/usrse.github.io/actions?query=workflow%3A%22Check+URLs%22\nhttps://github.com/SuperKogito/Voice-based-gender-recognition/issues\nhttps://github.com/buildtesters/buildtest/blob/v0.9.1/.github/workflows/urlchecker.yml\nhttps://github.com/berlin-hack-and-tell/berlinhackandtell.rocks/blob/master/.github/workflows/urlchecker-pr-label.yml\n\n /tmp/urlchecker-action/examples/README.md \n -----------------------------------------\nhttps://github.com/urlstechie/urlchecker-action/releases\nhttps://github.com/urlstechie/urlchecker-action/issues\nhttps://help.github.com/en/actions/reference/events-that-trigger-workflows\n\n\nDone. The following urls did not pass:\nhttps://github.com/SuperKogito/URLs-checker/issues/1,https://github.com/SuperKogito/URLs-checker/issues/2\n```\n\nThe url that didn't pass above is an example parameter for the library! Let's add\na simple pattern to exclude it.\n\n```bash\n$ urlchecker check --exclude-pattern SuperKogito .\n original path: .\n final path: /tmp/urlchecker-action\n subfolder: None\n branch: master\n cleanup: False\n file types: ['.md', '.py']\n files: []\n print all: True\n urls excluded: []\n url patterns excluded: ['SuperKogito']\n file patterns excluded: []\n force pass: False\n retry count: 2\n save: None\n timeout: 5\n\n /tmp/urlchecker-action/README.md \n --------------------------------\nhttps://github.com/urlstechie/urlchecker-action/blob/master/LICENSE\nhttps://github.com/urlstechie/urlchecker-action/issues\nhttps://github.com/rseng/awesome-rseng/actions?query=workflow%3AURLChecker\nhttps://github.com/USRSE/usrse.github.io/actions?query=workflow%3A%22Check+URLs%22\nhttps://github.com/actions/checkout\nhttps://github.com/USRSE/usrse.github.io/blob/abcbed5f5703e0d46edb9e8850eea8bb623e3c1c/.github/workflows/urlchecker.yml\nhttps://github.com/r-hub/docs/blob/bc1eac71206f7cb96ca00148dcf3b46c6d25ada4/.github/workflows/pr.yml\nhttps://github.com/berlin-hack-and-tell/berlinhackandtell.rocks/blob/master/.github/workflows/urlchecker-pr-label.yml\nhttps://github.com/rseng/awesome-rseng\nhttps://www.codefactor.io/repository/github/urlstechie/urlchecker-action/badge\nhttps://github.com/urlstechie/URLs-checker-test-repo\nhttps://www.codefactor.io/repository/github/urlstechie/urlchecker-action\nhttps://github.com/r-hub/docs\nhttps://github.com/berlin-hack-and-tell/berlinhackandtell.rocks\nhttps://github.com/buildtesters/buildtest\nhttps://img.shields.io/badge/license-MIT-brightgreen\nhttps://github.com/urlstechie/urlchecker-action/releases\nhttps://github.com/marketplace/actions/urlchecker-action\nhttps://img.shields.io/static/v1?label=Marketplace&message=urlchecker-action&color=blue?style=flat&logo=github\nhttps://github.com/r-hub/docs/actions?query=workflow%3ACommands\nhttps://github.com/HPC-buildtest/buildtest-framework/actions?query=workflow%3A%22Check+URLs%22\nhttps://github.com/buildtesters/buildtest/blob/v0.9.1/.github/workflows/urlchecker.yml\nhttps://github.com/berlin-hack-and-tell/berlinhackandtell.rocks/actions?query=workflow%3ACommands\nhttps://github.com/USRSE/usrse.github.io\nhttps://github.com/rseng/awesome-rseng/blob/5f5cb78f8392cf10aec2f3952b305ae9611029c2/.github/workflows/urlchecker.yml\n\n /tmp/urlchecker-action/examples/README.md \n -----------------------------------------\nhttps://help.github.com/en/actions/reference/events-that-trigger-workflows\nhttps://github.com/urlstechie/urlchecker-action/issues\nhttps://github.com/urlstechie/urlchecker-action/releases\n\n\nDone. All URLS passed.\n```\n\nWe can also filter by file types. If we want to do this (for example, to only check different file\ntypes) we might do any of the following:\n\n```bash\n# Check only html files\nurlchecker check --file-types *.html .\n\n# Check hidden flies\nurlchecker check --file-types \".*\" .\n\n# Check hidden files and html files\nurlchecker check --file-types \".*,*.html\" .\n```\n\n**Note that while some patterns will work without quotes, it's recommended for most**\nto use them because if the shell expands any part of the pattern, it will not work as\nexpected. By default, the urlchecker checks python and markdown. If a multiprocessing workers has an error,\nyou can also add `--serial` to run in serial and test. The run will be slower, but it's useful for debugging.\n\n```bash\n$ urlchecker check . --files \"content/docs/hacking/contributing/documentation/index.md\" --serial\n```\n\n### Check GitHub Repository\n\nBut wouldn't it be easier to not have to clone the repository first?\nOf course! We can specify a GitHub url instead, and add `--cleanup`\nif we want to clean up the folder after.\n\n```bash\n$ urlchecker check https://github.com/SuperKogito/SuperKogito.github.io.git\n```\n\nIf you specify any arguments for a white list (or any kind of expected list) make\nsure that you provide a comma separated list *without any spaces*\n\n```bash\n$ urlchecker check --exclude-files=README.md,_config.yml\n```\n\n### Save Results\n\nIf you want to save your results to file, perhaps for some kind of record or\nother data analysis, you can provide the `--save` argument:\n\n```bash\n$ urlchecker check --save results.csv .\n```\n\nThe file that you save to will include a comma separated value tabular listing\nof the urls, and their result. The result options are \"passed\" and \"failed\"\nand the default header is `URL,RESULT`. All of these defaults are exposed\nif you want to change them (e.g., using a tab separator or a different header)\nif you call the function from within Python. Here is an example of the default file\nproduced, which should satisfy most use cases:\n\n```\nURL,RESULT\nhttps://github.com/SuperKogito,passed\nhttps://www.google.com/,passed\nhttps://github.com/SuperKogito/Voice-based-gender-recognition/issues,passed\nhttps://github.com/SuperKogito/Voice-based-gender-recognition,passed\nhttps://github.com/SuperKogito/spafe/issues/4,passed\nhttps://github.com/SuperKogito/Voice-based-gender-recognition/issues/2,passed\nhttps://github.com/SuperKogito/spafe/issues/5,passed\nhttps://github.com/SuperKogito/URLs-checker/blob/master/README.md,passed\nhttps://img.shields.io/,passed\nhttps://github.com/SuperKogito/spafe/,passed\nhttps://github.com/SuperKogito/spafe/issues/3,passed\nhttps://www.google.com/,passed\nhttps://github.com/SuperKogito,passed\nhttps://github.com/SuperKogito/spafe/issues/8,passed\nhttps://github.com/SuperKogito/spafe/issues/7,passed\nhttps://github.com/SuperKogito/Voice-based-gender-recognition/issues/1,passed\nhttps://github.com/SuperKogito/spafe/issues,passed\nhttps://github.com/SuperKogito/URLs-checker/issues,passed\nhttps://github.com/SuperKogito/spafe/issues/2,passed\nhttps://github.com/SuperKogito/URLs-checker,passed\nhttps://github.com/SuperKogito/spafe/issues/6,passed\nhttps://github.com/SuperKogito/spafe/issues/1,passed\nhttps://github.com/SuperKogito/URLs-checker/README.md,failed\nhttps://github.com/SuperKogito/URLs-checker/issues/3,failed\nhttps://none.html,failed\nhttps://github.com/SuperKogito/URLs-checker/issues/2,failed\nhttps://github.com/SuperKogito/URLs-checker/README.md,failed\nhttps://github.com/SuperKogito/URLs-checker/issues/1,failed\nhttps://github.com/SuperKogito/URLs-checker/issues/4,failed\n```\n\n\n### Usage from Python\n\n#### Checking a Path\n\nIf you want to check a list of urls outside of the provided client, this is fairly easy to do!\nLet's say we have a path, our present working directory, and we want to check\n.py and .md files (the default)\n\n```python\nfrom urlchecker.core.check import UrlChecker\nimport os\n\npath = os.getcwd()\nchecker = UrlChecker(path) \n# UrlChecker:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python\n```\n\nAnd of course you can provide more substantial arguments to derive the original\nfile list:\n\n```python\nchecker = UrlChecker(\n path=path,\n file_types=[\".md\", \".py\", \".rst\"],\n include_patterns=[],\n exclude_files=[\"README.md\", \"LICENSE\"],\n print_all=True,\n)\n```\nI can then run the checker like this:\n\n```python\nchecker.run()\n```\n\nOr with more customization of excluded urls:\n\n```python\nchecker.run(\n exclude_urls=exclude_urls,\n exclude_patterns=exclude_patterns,\n retry_count=3,\n timeout=5,\n)\n```\n\nYou'll get the results object returned, which is also available at `checker.results`,\na simple dictionary with \"passed\" and \"failed\" keys to show passes and fails across\nall files.\n\n```python\n{'passed': ['https://github.com/SuperKogito/spafe/issues/4',\n 'http://shachi.org/resources',\n 'https://superkogito.github.io/blog/SpectralLeakageWindowing.html',\n 'https://superkogito.github.io/figures/fig4.html',\n 'https://github.com/urlstechie/urlchecker-test-repo',\n 'https://www.google.com/',\n ...\n 'https://github.com/SuperKogito',\n 'https://img.shields.io/',\n 'https://www.google.com/',\n 'https://docs.python.org/2'],\n 'failed': ['https://github.com/urlstechie/urlschecker-python/tree/master',\n 'https://github.com/SuperKogito/Voice-based-gender-recognition,passed',\n 'https://github.com/SuperKogito/URLs-checker/README.md',\n ...\n 'https://superkogito.github.io/tables',\n 'https://github.com/SuperKogito/URLs-checker/issues/2',\n 'https://github.com/SuperKogito/URLs-checker/README.md',\n 'https://github.com/SuperKogito/URLs-checker/issues/4',\n 'https://github.com/SuperKogito/URLs-checker/issues/3',\n 'https://github.com/SuperKogito/URLs-checker/issues/1',\n 'https://none.html']}\n```\n\nYou can look at `checker.checks`, which is a dictionary of result objects,\norganized by the filename:\n\n```python\nfor file_name, result in checker.checks.items(): \n print() \n print(result) \n print(\"Total Results: %s \" % result.count) \n print(\"Total Failed: %s\" % len(result.failed)) \n print(\"Total Passed: %s\" % len(result.passed)) \n\n...\n\nUrlCheck:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python/tests/test_files/sample_test_file.md\nTotal Results: 26 \nTotal Failed: 6\nTotal Passed: 20\n\nUrlCheck:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python/.pytest_cache/README.md\nTotal Results: 1 \nTotal Failed: 0\nTotal Passed: 1\n\nUrlCheck:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python/.eggs/pytest_runner-5.2-py3.7.egg/ptr.py\nTotal Results: 0 \nTotal Failed: 0\nTotal Passed: 0\n\nUrlCheck:/home/vanessa/Desktop/Code/urlstechie/urlchecker-python/docs/source/conf.py\nTotal Results: 3 \nTotal Failed: 0\nTotal Passed: 3\n```\n\nFor any result object, you can print the list of passed, falied, white listed,\nor all the urls.\n\n```python\nresult.all \n['https://www.sphinx-doc.org/en/master/usage/configuration.html',\n 'https://docs.python.org/3',\n 'https://docs.python.org/2']\n\nresult.failed \n[]\n\nresult.exclude\n[]\n\nresult.passed \n['https://www.sphinx-doc.org/en/master/usage/configuration.html',\n 'https://docs.python.org/3',\n 'https://docs.python.org/2']\n\nresult.count\n3\n```\n\n\n#### Checking a List of URls\n\nIf you start with a list of urls you want to check, you can do that too!\n\n```python\nfrom urlchecker.core.urlproc import UrlCheckResult\n\nurls = ['https://www.github.com', \"https://github.com\", \"https://banana-pudding-doesnt-exist.com\"]\n\n# Instantiate an empty checker to extract urls\nchecker = UrlCheckResult()\nFile name None is undefined or does not exist, skipping extraction.\n```\n\nIf you provied a file name, the urls would be extracted for you.\n\n```python\nchecker = UrlCheckResult(\n file_name=file_name,\n exclude_patterns=exclude_patterns,\n exclude_urls=exclude_urls,\n print_all=self.print_all,\n)\n```\n\nor you can provide all the parameters without the filename:\n\n```python\nchecker = UrlCheckResult(\n exclude_patterns=exclude_patterns,\n exclude_urls=exclude_urls,\n print_all=self.print_all,\n)\n```\n\nIf you don't provide the file_name to check urls, you can give the urls\nyou defined previously directly to the `check_urls` function:\n\n\n```python\nchecker.check_urls(urls)\n\nhttps://www.github.com\nhttps://github.com\nHTTPSConnectionPool(host='banana-pudding-doesnt-exist.com', port=443): Max retries exceeded with url: / (Caused by NewConnectionError('<urllib3.connection.VerifiedHTTPSConnection object at 0x7f989abdfa10>: Failed to establish a new connection: [Errno -2] Name or service not known'))\nhttps://banana-pudding-doesnt-exist.com\n```\n\nAnd of course you can specify a timeout and retry:\n\n```python\nchecker.check_urls(urls, retry_count=retry_count, timeout=timeout)\n```\n\nAfter you run the checker you can get all the urls, the passed,\nand failed sets:\n\n```python\nchecker.failed \n['https://banana-pudding-doesnt-exist.com']\n\nchecker.passed \n['https://www.github.com', 'https://github.com']\n\nchecker.all \n['https://www.github.com',\n 'https://github.com',\n 'https://banana-pudding-doesnt-exist.com']\n\nchecker.all \n['https://www.github.com',\n 'https://github.com',\n 'https://banana-pudding-doesnt-exist.com']\n\nchecker.count \n3\n```\n\nIf you have any questions, please don't hesitate to [open an issue](https://github.com/urlstechie/urlchecker-python).\n\n### Docker\n\nA Docker container is provided if you want to build a base container with urlchecker,\nmeaning that you don't need to install it on your host. You can build the container as\nfollows:\n\n```bash\ndocker build -t urlchecker .\n```\n\nAnd then the entrypoint will expose the urlchecker.\n\n```bash\ndocker run -it urlschecker\n```\n\n## Development\n\n### Organization\n\nThe module is organized as follows:\n\n```\n\u251c\u2500\u2500 client # command line client\n\u251c\u2500\u2500 main # functions for supported integrations (e.g., GitHub)\n\u251c\u2500\u2500 core # core file and url processing tools\n\u2514\u2500\u2500 version.py # package and versioning\n```\n\nIn the \"client\" folder, for example, the commands that are exposed for the client\n(e.g., check) would named accordingly, e.g., `client/check.py`.\nFunctions for Github are be provided in `main/github.py`. This organization should\nbe fairly straight forward to always find what you are looking for.\n\n### Drivers\n\nTo test more difficult urls, we use a web driver, and you can choose between:\n\n - [Chrome Driver](https://chromedriver.chromium.org/downloads)\n - [Gecko Driver](https://github.com/mozilla/geckodriver/releases) (firefox)\n \nboth to be used with selenium. This driver is optional, but will come by default with our action. To install\nit, you can download the driver at either of the links above and ensure you install selenium:\n\n```bash\n$ pip install urlchecker[selenium]\n```\nand either:\n\n1. Add it directly to your path\n2. Export the directory where it lives as `URLCHECKER_DRIVERS_PATH`\n3. Put it in the root of the urlchecker clone (it will be looked for here)\n\n\n## Support\n\nIf you need help, or want to suggest a project for the organization,\nplease [open an issue](https://github.com/urlstechie/urlchecker-python)\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "tool to collect and validate urls over static files (code and documentation)",
"version": "0.0.35",
"project_urls": {
"Homepage": "http://www.github.com/urlstechie/urlchecker-python"
},
"split_keywords": [
"urls",
"static checking",
"checking",
"validation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "087eef9950a258bcbb5d2770aef1bd681a471d12b871d55f1f6883c8ac41514d",
"md5": "c92c09038db0d2908dd58549bcf92e09",
"sha256": "a6297b4627ead89a71dcc1c03a366fd9380640bf2a02d7135edcd48ff7a44290"
},
"downloads": -1,
"filename": "urlchecker-0.0.35-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c92c09038db0d2908dd58549bcf92e09",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 97388,
"upload_time": "2024-02-03T22:48:12",
"upload_time_iso_8601": "2024-02-03T22:48:12.254423Z",
"url": "https://files.pythonhosted.org/packages/08/7e/ef9950a258bcbb5d2770aef1bd681a471d12b871d55f1f6883c8ac41514d/urlchecker-0.0.35-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9711b87b3e014d93bfb7dc288fe907fefdf401bf2a35494cdaef9438d2e701e5",
"md5": "7503f2358a0819d2011eab676eb451e5",
"sha256": "e303c4d240f3e00e21583bf9636e6792b4d7abd889de5b3114e78662cd2b7f45"
},
"downloads": -1,
"filename": "urlchecker-0.0.35.tar.gz",
"has_sig": false,
"md5_digest": "7503f2358a0819d2011eab676eb451e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 90890,
"upload_time": "2024-02-03T22:48:14",
"upload_time_iso_8601": "2024-02-03T22:48:14.759583Z",
"url": "https://files.pythonhosted.org/packages/97/11/b87b3e014d93bfb7dc288fe907fefdf401bf2a35494cdaef9438d2e701e5/urlchecker-0.0.35.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-03 22:48:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "urlstechie",
"github_project": "urlchecker-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "urlchecker"
}
JSON
