From 45578724d267f1f082878b7d1e5c88f79e6f8855 Mon Sep 17 00:00:00 2001 From: funilrys Date: Tue, 19 Dec 2023 17:35:20 +0100 Subject: [PATCH] Fix some typos and semantics. --- README.md | 18 +++++++----- docs/index.md | 2 +- docs/use/configuration/location.md | 2 +- docs/use/faq.md | 6 ++-- docs/use/installation.md | 47 +++++++++++++++++++----------- docs/use/update.md | 40 +++++++++++++++++++++++-- mkdocs.yml | 7 ++--- requirements.docs.txt | 4 ++- 8 files changed, 89 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index e375f96e..c1a25f25 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,8 @@ Happy testing with PyFunceble! # Table of Content +- [The tool to check the availability or syntax of domain, IP or URL](#the-tool-to-check-the-availability-or-syntax-of-domain-ip-or-url) +- [Table of Content](#table-of-content) - [Installation](#installation) - [Packages \& Versioning](#packages--versioning) - [PyPi - Python Package Index](#pypi---python-package-index) @@ -244,18 +246,18 @@ up-to-date by yourself. Here is an overview of the packages and where they are hosted. -| Host | Package | Repository | -|--------|----------------|------------------------------------------------------------------------------------------------------------| -| GitHub | pyfunceble | [https://github.com/funilrys/PyFunceble/tree/master](https://github.com/funilrys/PyFunceble/tree/master) | -| GitHub | pyfunceble-dev | [https://github.com/funilrys/PyFunceble/tree/dev](https://github.com/funilrys/PyFunceble/tree/dev) | -| GitLab | pyfunceble | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | -| GitLab | pyfunceble-dev | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | +| Host | Package | Branch | Repository | +| ------ | -------------- | -------- | -------------------------------------------------------------------------------------------------------- | +| GitHub | pyfunceble | `master` | [https://github.com/funilrys/PyFunceble/tree/master](https://github.com/funilrys/PyFunceble/tree/master) | +| GitHub | pyfunceble-dev | `dev` | [https://github.com/funilrys/PyFunceble/tree/dev](https://github.com/funilrys/PyFunceble/tree/dev) | +| GitLab | pyfunceble | `master` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | +| GitLab | pyfunceble-dev | `dev` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | You can install the package from source through `pip3`: ```shell -cd /path/to/source -pip3 install --user . +pip3 install --user https://github.com/funilrys/PyFunceble/archive/{{branch}}.zip # From Github +pip3 install --user https://gitlab.com/funilrys/PyFunceble/-/archive/{{branch}}/PyFunceble-{{branch}}.zip # From GitLab ``` # Usage diff --git a/docs/index.md b/docs/index.md index f2e4ecce..e0190996 100644 --- a/docs/index.md +++ b/docs/index.md @@ -47,7 +47,7 @@ PyFunceble can be included in your existing project through: - its standard built-in CLI implementation. - its [Python - API](./develop/api-references). + API](./develop/api-references/index.md). - the [PyFunceble web-worker](https://github.com/pyfunceble/web-worker) (beta) project that provides the core functionalities of PyFunceble behind a web API. diff --git a/docs/use/configuration/location.md b/docs/use/configuration/location.md index 5fb3a847..f391bdc5 100644 --- a/docs/use/configuration/location.md +++ b/docs/use/configuration/location.md @@ -69,4 +69,4 @@ That means, that if you don't set the `PYFUNCEBLE_CONFIG_DIR` environment variab If you cloned the [PyFunceble](https://github.com/funilrys/PyFunceble) repository, and you are trying to run a test from the root folder, PyFunceble will consider -the root folder as its configuration directory. +the repository's root folder as its configuration directory. diff --git a/docs/use/faq.md b/docs/use/faq.md index e49e7bc4..eb46b5d9 100644 --- a/docs/use/faq.md +++ b/docs/use/faq.md @@ -16,14 +16,14 @@ - Disk I/O in particular as PyFunceble is heavy on the I/O _(cf: RAM Drives and NVMe disks are very suitable for PyFunceble's CSV storage)_ - ... -### With dedicated Server, VM or machine - If you have a dedicated server, VM or machine for PyFunceble, you can simply increase the number of maximal workers PyFunceble is allowed to use through the `--max-workers` argument or its `cli_testing.max_workers` setting. -By default, the number of worker is equal to the number of CPU Cores minus 2 (`CPU Cores - 2`). +By default, the number of worker is equal to the number of CPU Cores minus 2 (`CPU Cores - 2`), +but with a minimum of 1. Meaning that if you have `8` CPU threads, the value will be automatically set to `6`. +If you have `2` CPU threads, the value will be automatically set to `1`. If that is still not sufficient for you, and you feel chancy, you my try to use the dangerous `--chancy` argument. diff --git a/docs/use/installation.md b/docs/use/installation.md index 64839301..868a5fd3 100644 --- a/docs/use/installation.md +++ b/docs/use/installation.md @@ -22,6 +22,15 @@ For most people the `pyfunceble` package should be sufficient. But if you want t the community or always want to have the latest features and bugfix as soon as possible, you should prefer the `pyfunceble-dev` package. +## Overview: Installation Method + +| OS | Technology | Tools | Link | +| --------- | --------------------------- | ------------ | ------------------------------------ | +| Any | PyPi - Python Package Index | `pip3` | [Link](#pypi---python-package-index) | +| Any | Container Image Registry | `docker` | [Link](#container-image-registry) | +| Any | Git | `pip3` | [Link](#git-repository) | +| Any | Zip File | `pip3` | [Link](#from-source) | +| ArchLinux | AUR Helper | `aur-helper` | [Link](#arch-linux) | ## PyPi - Python Package Index @@ -31,7 +40,7 @@ the OS specific packages _(see below)_. Here is an overview of the packages and where they are hosted. | Package | PyPi Link | -|----------------|---------------------------------------------------------------------------------| +| -------------- | ------------------------------------------------------------------------------- | | pyfunceble | [https://pypi.org/project/PyFunceble](https://pypi.org/project/PyFunceble) | | pyfunceble-dev | [https://pypi.org/project/PyFunceblee-dev](https://pypi.org/project/PyFunceble) | @@ -80,7 +89,7 @@ is available. :smile: Here is an overview of the packages and where they are hosted. | Host | Package | Link | -|------------|----------------|----------------------------------------------------------------------------------------------------------| +| ---------- | -------------- | -------------------------------------------------------------------------------------------------------- | | Docker Hub | pyfunceble | [https://hub.docker.com/r/pyfunceble/pyfunceble](https://hub.docker.com/r/pyfunceble/pyfunceble) | | Docker Hub | pyfunceble-dev | [https://hub.docker.com/r/pyfunceble/pyfunceble-dev](https://hub.docker.com/r/pyfunceble/pyfunceble-dev) | @@ -112,7 +121,7 @@ ArchLinux. Here is an overview of the packages and where they are hosted. | Package | AUR Link | -|----------------|--------------------------------------------------------------------------------------------------------| +| -------------- | ------------------------------------------------------------------------------------------------------ | | pyfunceble | [https://aur.archlinux.org/packages/pyfunceble](https://aur.archlinux.org/packages/pyfunceble) | | pyfunceble-dev | [https://aur.archlinux.org/packages/pyfunceble-dev](https://aur.archlinux.org/packages/pyfunceble-dev) | @@ -131,7 +140,8 @@ aur-helper -S pyfunceble You can install the **pyfunceble** package manually through the following: ```shell -curl https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h=pyfunceble -o PKGBUILD +git clone https://aur.archlinux.org/pyfunceble.git pyfunceble +cd pyfunceble makepkg -fsri ``` @@ -150,21 +160,22 @@ aur-helper -S pyfunceble-dev You can install the **pyfunceble** package manually through the following: ```shell -curl https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h=pyfunceble-dev -o PKGBUILD +git clone https://aur.archlinux.org/pyfunceble-dev.git pyfunceble-dev +cd pyfunceble-dev makepkg -fsri ``` ## Git Repository Installing from a Git Repository with `pip3` is not recommended for general user as -you will get the latest development patches even before they get published. But if you +you will easily get the latest development patches even before they get published. But if you are one of those who always want to be in sync with the latest development patches, this is probably for you. Here is an overview of the packages and where they are hosted. | Host | Package | Repository | -|--------|----------------|-------------------------------------------------------------------------| +| ------ | -------------- | ----------------------------------------------------------------------- | | GitHub | pyfunceble | `git+https://github.com/funilrys/PyFunceble.git@master#egg=PyFunceble` | | GitHub | pyfunceble-dev | `git+https://github.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev` | | GitLab | pyfunceble | `git+https://gitlab.com/funilrys/PyFunceble.git@master#egg=PyFunceble` | @@ -226,17 +237,19 @@ up-to-date by yourself. Here is an overview of the packages and where they are hosted. -| Host | Package | Repository | -|--------|----------------|------------------------------------------------------------------------------------------------------------| -| GitHub | pyfunceble | [https://github.com/funilrys/PyFunceble/tree/master](https://github.com/funilrys/PyFunceble/tree/master) | -| GitHub | pyfunceble-dev | [https://github.com/funilrys/PyFunceble/tree/dev](https://github.com/funilrys/PyFunceble/tree/dev) | -| GitLab | pyfunceble | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | -| GitLab | pyfunceble-dev | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | +| Host | Package | Branch | Repository | +| ------ | -------------- | -------- | -------------------------------------------------------------------------------------------------------- | +| GitHub | pyfunceble | `master` | [https://github.com/funilrys/PyFunceble/tree/master](https://github.com/funilrys/PyFunceble/tree/master) | +| GitHub | pyfunceble-dev | `dev` | [https://github.com/funilrys/PyFunceble/tree/dev](https://github.com/funilrys/PyFunceble/tree/dev) | +| GitLab | pyfunceble | `master` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | +| GitLab | pyfunceble-dev | `dev` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | You can install the package from source through `pip3`: ```shell -cd /path/to/source -git checkout dev|master # switch to desired branch - if source is a git repo -pip3 install --user . -``` +# From Github +pip3 install --upgrade --user https://github.com/funilrys/PyFunceble/archive/{{branch}}.zip + +# From GitLab +pip3 install --upgrade --user https://gitlab.com/funilrys/PyFunceble/-/archive/{{branch}}/PyFunceble-{{branch}}.zip +``` \ No newline at end of file diff --git a/docs/use/update.md b/docs/use/update.md index 9fa3a270..c0c5cfc7 100644 --- a/docs/use/update.md +++ b/docs/use/update.md @@ -2,6 +2,15 @@ Updating PyFunceble is as easy as the installation. +## Overview: Update Method + +| OS | Technology | Tools | Link | +| --------- | --------------------------- | ------------ | ------------------------------------ | +| Any | PyPi - Python Package Index | `pip3` | [Link](#pypi---python-package-index) | +| Any | Container Image Registry | `docker` | [Link](#container-image-registry) | +| Any | Git | `pip3` | [Link](#git-repository) | +| Any | Zip File | `pip3` | [Link](#from-source) | +| ArchLinux | AUR Helper | `aur-helper` | [Link](#arch-linux) | ## PyPi - Python Package Index @@ -91,7 +100,8 @@ aur-helper -Syu pyfunceble You can update the **pyfunceble** package manually through the following: ```shell -curl https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h=pyfunceble -o PKGBUILD +git clone https://aur.archlinux.org/pyfunceble.git pyfunceble +cd pyfunceble makepkg -fsri ``` @@ -110,7 +120,8 @@ aur-helper -Syu pyfunceble-dev You can update the **pyfunceble** package manually through the following: ```shell -curl https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h=pyfunceble-dev -o PKGBUILD +git clone https://aur.archlinux.org/pyfunceble-dev.git pyfunceble-dev +cd pyfunceble-dev makepkg -fsri ``` @@ -176,4 +187,29 @@ You can update the **pyfunceble-dev** package from GitLab through `pip3`: ```shell pip3 install --user --upgrade git+https://gitlab.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev +``` + +## From Source + +Updating from the source with `pip3` is just like a normal update of `pip` +installed package. Just add `--upgrade` to your installation command and you are good +to go. + +Here is an overview of the packages and where they are hosted. + +| Host | Package | Branch | Repository | +| ------ | -------------- | -------- | -------------------------------------------------------------------------------------------------------- | +| GitHub | pyfunceble | `master` | [https://github.com/funilrys/PyFunceble/tree/master](https://github.com/funilrys/PyFunceble/tree/master) | +| GitHub | pyfunceble-dev | `dev` | [https://github.com/funilrys/PyFunceble/tree/dev](https://github.com/funilrys/PyFunceble/tree/dev) | +| GitLab | pyfunceble | `master` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | +| GitLab | pyfunceble-dev | `dev` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) | + +You can install the package from source through `pip3`: + +```shell +# From Github +pip3 install --upgrade --user https://github.com/funilrys/PyFunceble/archive/{{branch}}.zip + +# From GitLab +pip3 install --upgrade --user https://gitlab.com/funilrys/PyFunceble/-/archive/{{branch}}/PyFunceble-{{branch}}.zip ``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index f2f52252..356423e5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,8 +45,8 @@ markdown_extensions: - tables - attr_list - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg plugins: - search @@ -68,7 +68,6 @@ plugins: - git-revision-date-localized: enable_creation_date: yes fallback_to_build_date: yes - - termynal repo_name: funilrys/PyFunceble repo_url: https://github.com/funilrys/PyFunceble @@ -108,7 +107,7 @@ nav: - URL Availability: develop/examples/url-availability.md - URL Syntax: develop/examples/url-syntax.md - File Generation: develop/examples/file-generation.md - - Code References: develop/api-references/ + - Code References: develop/api-references/index.md - Contribution Guides: - Contributing: contributing/contributing.md - Code of Conduct: contributing/code-of-conduct.md diff --git a/requirements.docs.txt b/requirements.docs.txt index ad7d4e15..b221760b 100644 --- a/requirements.docs.txt +++ b/requirements.docs.txt @@ -11,4 +11,6 @@ mkdocs-git-revision-date-localized-plugin mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index -mkdocs-git-authors-plugin \ No newline at end of file +mkdocs-git-authors-plugin +mkdocs-macros-plugin +pymdown-extensions \ No newline at end of file