Metadata-Version: 2.1
Name: seoaudit
Version: 0.0.1.dev3
Summary: Run SEO checks on a set of urls.
Home-page: https://github.com/Guber/seoaudit
Author: Emanuel Guberovic
Author-email: emanuel.guberovic@gmail.com
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: requests
Requires-Dist: lxml
Requires-Dist: nltk
Requires-Dist: extruct
Requires-Dist: selenium
Requires-Dist: json2html
Provides-Extra: selenium_parser_feature
Requires-Dist: selenium ; extra == 'selenium_parser_feature'


# SEOAudit

SEO tool for analyzing a set of urls, crawls the pages and audits a set of predefined checks element, page and site
 tests on them.
 
### Main features

- Python3 CLI script with JSON (and soon HTML) reports
- Python3 API
- Tests configurable and parameterized

### Why yet another SEO tool?
SEO (Search Engine Optimization) is a set of activities with a goal to
increase organic traffic from search engines to the website.
On-page SEO (as oppsed to off-site SEO) is a set of on-page optimizations such as optimization of the HTML tags used, 
content quality, speed, etc.

SEOaudit is an **on-site SEO tool** that differs to other SEO tools i na way that 
it is **completely configurable**, **interoperable** into development environment either as a CLI 
script or through its API usage and it is **completely free**!

## Requirements

Python 3.6+ and modules `requests`, `lxml`, `nltk`, `extruct`, `selenium`.

## Installation

To install run: `pip install seoaudit`.

## Using CLI

For analyzing a single site with default checks run with `seoaudit -u URL`, e.g.:
`seoaudit -u https://green-light.agency`.

To define extra urls just add another `u URL` argument:
`seoaudit -u https://green-light.agency -u https://milenial.eu`.

To use custom python checks config file (e.g. config.py) use option `-c PYTHON_MODULE`:
`seoaudit -u https://green-light.agency -c config`.

To parse sitemap.xml for extra urls to parse add `-p`:
`seoaudit -u https://green-light.agency -p`.

## Documentation

Extra documentation including API documentation and examples on extending the module with custom checks:
[SEOAudit documentation](https://seoaudit.readthedocs.io/ "SEOAudit documentation").
