| Name | wasc JSON |
| Version |
1.0.6
JSON |
| download |
| home_page | None |
| Summary | Web Accessibility Simple Checker |
| upload_time | 2023-12-04 09:37:41 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
accessibility
checker
criteria
web
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Web Accessibility Simple Checker
[](https://pypi.org/project/wasc)
[](https://pypi.org/project/wasc)
[](https://github.com/atelierPartage/wasc/actions/workflows/docs.yml)
-----
**Table of Contents**
- [Web Accessibility Simple Checker](#web-accessibility-simple-checker)
- [](#)
- [Installation](#installation)
- [Usage](#usage)
- [Documentation](#documentation)
- [License](#license)
- [Developpement](#developpement)
- [Dependencies](#dependencies)
- [Running wasc with hatch](#running-wasc-with-hatch)
- [Testing wasc with hatch](#testing-wasc-with-hatch)
## Installation
```console
pip install wasc
```
## Usage
```bash
Usage: wasc [OPTIONS] WEBSITES
Websites Accessibility Criteria Checker, helps to
evaluate accessibility on a list of websites
WEBSITES is a CSV file containing a list of websites
as couples "label";"URL"
Options:
-c, --checkers PATH Path to the list of checkers
-f, --output_format [json|csv] Output format [default=json]
-o, --output FILENAME Output file [default=stdout]
--version Show the version and exit.
-h, --help Show this message and exit.
```
Example files are given in `data` directory
## Documentation
Documentation is available [here](https://atelierpartage.github.io/wasc/)
## License
`wasc` is distributed under the terms of the [CECILL-2.1](https://spdx.org/licenses/CECILL-2.1.html) license by the following licensors :
* Juliette Francis
* François le Berre
* Guillaume Collet
`wasc` main contact is [contact@latelierpartage.fr](mailto:contact@latelierpartage.fr)
For details about the license, see file [LICENSE.txt](https://github.com/atelierPartage/wasc/blob/main/LICENSE.txt)
## Developpement
Full source code is available on github : [https://github.com/gcollet/wasc](https://github.com/gcollet/wasc)
The project is developed under hatch project manager ([hatch.pypa.io](https://hatch.pypa.io/latest/))
### Dependencies
`hatch` project manager is mandatory. The other dependencies are managed with hatch environment system.
It is **not necessary** to install dependencies using `pip install -r requirements_dev.txt` but the file is present if needed.
### Running wasc with hatch
In `wasc` directory, use hatch to run wasc in the default environnement :
`hatch run wasc data/url_example.csv`
### Testing wasc with hatch
In `wasc` directory, use hatch to test wasc files in the default environnement :
`hatch run test_all`
Raw data
{
"_id": null,
"home_page": null,
"name": "wasc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Accessibility,Checker,Criteria,Web",
"author": null,
"author_email": "Guillaume Collet <bilouweb@free.fr>, Juliette Francis <juliette.francis@etudiant.univ-rennes.fr>",
"download_url": "https://files.pythonhosted.org/packages/ff/9d/d5261fcfa280cc5872b71afb688c276fd10796b03107337bd62b0ae6aacb/wasc-1.0.6.tar.gz",
"platform": null,
"description": "# Web Accessibility Simple Checker\n\n[](https://pypi.org/project/wasc)\n[](https://pypi.org/project/wasc)\n[](https://github.com/atelierPartage/wasc/actions/workflows/docs.yml)\n-----\n\n**Table of Contents**\n\n- [Web Accessibility Simple Checker](#web-accessibility-simple-checker)\n - [](#)\n - [Installation](#installation)\n - [Usage](#usage)\n - [Documentation](#documentation)\n - [License](#license)\n - [Developpement](#developpement)\n - [Dependencies](#dependencies)\n - [Running wasc with hatch](#running-wasc-with-hatch)\n - [Testing wasc with hatch](#testing-wasc-with-hatch)\n\n## Installation\n\n```console\npip install wasc\n```\n## Usage\n\n```bash\nUsage: wasc [OPTIONS] WEBSITES\n\n Websites Accessibility Criteria Checker, helps to \n evaluate accessibility on a list of websites\n\n WEBSITES is a CSV file containing a list of websites \n as couples \"label\";\"URL\"\n\nOptions:\n -c, --checkers PATH Path to the list of checkers\n -f, --output_format [json|csv] Output format [default=json]\n -o, --output FILENAME Output file [default=stdout]\n --version Show the version and exit.\n -h, --help Show this message and exit.\n```\n\nExample files are given in `data` directory\n\n## Documentation\n\nDocumentation is available [here](https://atelierpartage.github.io/wasc/)\n## License\n\n`wasc` is distributed under the terms of the [CECILL-2.1](https://spdx.org/licenses/CECILL-2.1.html) license by the following licensors :\n* Juliette Francis\n* Fran\u00e7ois le Berre\n* Guillaume Collet\n\n`wasc` main contact is [contact@latelierpartage.fr](mailto:contact@latelierpartage.fr)\n\nFor details about the license, see file [LICENSE.txt](https://github.com/atelierPartage/wasc/blob/main/LICENSE.txt)\n\n## Developpement\n\nFull source code is available on github : [https://github.com/gcollet/wasc](https://github.com/gcollet/wasc)\nThe project is developed under hatch project manager ([hatch.pypa.io](https://hatch.pypa.io/latest/))\n\n### Dependencies\n`hatch` project manager is mandatory. The other dependencies are managed with hatch environment system.\n\nIt is **not necessary** to install dependencies using `pip install -r requirements_dev.txt` but the file is present if needed.\n### Running wasc with hatch\nIn `wasc` directory, use hatch to run wasc in the default environnement :\n\n`hatch run wasc data/url_example.csv`\n\n### Testing wasc with hatch\nIn `wasc` directory, use hatch to test wasc files in the default environnement :\n\n`hatch run test_all`\n",
"bugtrack_url": null,
"license": null,
"summary": "Web Accessibility Simple Checker",
"version": "1.0.6",
"project_urls": {
"Documentation": "https://github.com/gcollet/wasc#readme",
"Issues": "https://github.com/gcollet/wasc/issues",
"Source": "https://github.com/gcollet/wasc"
},
"split_keywords": [
"accessibility",
"checker",
"criteria",
"web"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b5e84a08e5d0ac8eab48e76084ee05bd6c07c9fe259c1a95e415643855fadbe5",
"md5": "85cde09af6fda9139172db3dbbd71fb1",
"sha256": "52355cfdde280d6af3b3ef9ea4d4a7288fdd2acebea570b92e80bde02b87489a"
},
"downloads": -1,
"filename": "wasc-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85cde09af6fda9139172db3dbbd71fb1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17262,
"upload_time": "2023-12-04T09:37:39",
"upload_time_iso_8601": "2023-12-04T09:37:39.865847Z",
"url": "https://files.pythonhosted.org/packages/b5/e8/4a08e5d0ac8eab48e76084ee05bd6c07c9fe259c1a95e415643855fadbe5/wasc-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ff9dd5261fcfa280cc5872b71afb688c276fd10796b03107337bd62b0ae6aacb",
"md5": "95cc430f1c07e4ac9a4244a812f1a5fe",
"sha256": "f6bf0cbf9ccbd53736622d4ce6bdfc3367d7e007771ce0daf4d01f316dab5a13"
},
"downloads": -1,
"filename": "wasc-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "95cc430f1c07e4ac9a4244a812f1a5fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21089,
"upload_time": "2023-12-04T09:37:41",
"upload_time_iso_8601": "2023-12-04T09:37:41.755610Z",
"url": "https://files.pythonhosted.org/packages/ff/9d/d5261fcfa280cc5872b71afb688c276fd10796b03107337bd62b0ae6aacb/wasc-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 09:37:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gcollet",
"github_project": "wasc#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wasc"
}
