seoscoreapi 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- seoscoreapi-1.0.0/LICENSE +17 -0
- seoscoreapi-1.0.0/PKG-INFO +70 -0
- seoscoreapi-1.0.0/README.md +48 -0
- seoscoreapi-1.0.0/pyproject.toml +27 -0
- seoscoreapi-1.0.0/seoscoreapi/__init__.py +70 -0
- seoscoreapi-1.0.0/seoscoreapi.egg-info/PKG-INFO +70 -0
- seoscoreapi-1.0.0/seoscoreapi.egg-info/SOURCES.txt +9 -0
- seoscoreapi-1.0.0/seoscoreapi.egg-info/dependency_links.txt +1 -0
- seoscoreapi-1.0.0/seoscoreapi.egg-info/requires.txt +1 -0
- seoscoreapi-1.0.0/seoscoreapi.egg-info/top_level.txt +1 -0
- seoscoreapi-1.0.0/setup.cfg +4 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 SEO Score API
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: seoscoreapi
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Python client for SEO Score API — audit any URL for SEO issues with one function call
|
|
5
|
+
Author-email: SEO Score API <info@seoscoreapi.com>
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://seoscoreapi.com
|
|
8
|
+
Project-URL: Documentation, https://seoscoreapi.com/docs
|
|
9
|
+
Project-URL: Repository, https://github.com/SeoScoreAPI/examples
|
|
10
|
+
Keywords: seo,audit,api,seo-score,website-audit,seo-checker
|
|
11
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Topic :: Internet :: WWW/HTTP
|
|
16
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
17
|
+
Requires-Python: >=3.8
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
License-File: LICENSE
|
|
20
|
+
Requires-Dist: requests>=2.20
|
|
21
|
+
Dynamic: license-file
|
|
22
|
+
|
|
23
|
+
# seoscoreapi
|
|
24
|
+
|
|
25
|
+
Python client for [SEO Score API](https://seoscoreapi.com) — audit any URL for SEO issues with one function call.
|
|
26
|
+
|
|
27
|
+
## Install
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pip install seoscoreapi
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Quick Start
|
|
34
|
+
|
|
35
|
+
```python
|
|
36
|
+
from seoscoreapi import audit, signup
|
|
37
|
+
|
|
38
|
+
# Get a free API key (5 audits/day)
|
|
39
|
+
key = signup("you@example.com")
|
|
40
|
+
|
|
41
|
+
# Audit any URL
|
|
42
|
+
result = audit("https://example.com", api_key=key)
|
|
43
|
+
print(f"Score: {result['score']}/100 ({result['grade']})")
|
|
44
|
+
|
|
45
|
+
# See what to fix
|
|
46
|
+
for p in result["priorities"]:
|
|
47
|
+
print(f" [{p['severity']}] {p['issue']}")
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Functions
|
|
51
|
+
|
|
52
|
+
| Function | Description |
|
|
53
|
+
|----------|-------------|
|
|
54
|
+
| `signup(email)` | Get a free API key |
|
|
55
|
+
| `audit(url, api_key)` | Run SEO audit on a URL |
|
|
56
|
+
| `batch_audit(urls, api_key)` | Audit multiple URLs (paid) |
|
|
57
|
+
| `usage(api_key)` | Check your usage/limits |
|
|
58
|
+
| `add_monitor(url, api_key)` | Set up score monitoring (paid) |
|
|
59
|
+
| `list_monitors(api_key)` | List active monitors |
|
|
60
|
+
| `report_url(domain)` | Get shareable report URL |
|
|
61
|
+
|
|
62
|
+
## What Gets Checked
|
|
63
|
+
|
|
64
|
+
28 checks across 5 categories: meta & content, technical SEO, social/OG, performance, accessibility.
|
|
65
|
+
|
|
66
|
+
## Links
|
|
67
|
+
|
|
68
|
+
- [Website & Live Demo](https://seoscoreapi.com)
|
|
69
|
+
- [API Docs](https://seoscoreapi.com/docs)
|
|
70
|
+
- [GitHub Action](https://github.com/SeoScoreAPI/seo-audit-action)
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# seoscoreapi
|
|
2
|
+
|
|
3
|
+
Python client for [SEO Score API](https://seoscoreapi.com) — audit any URL for SEO issues with one function call.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pip install seoscoreapi
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```python
|
|
14
|
+
from seoscoreapi import audit, signup
|
|
15
|
+
|
|
16
|
+
# Get a free API key (5 audits/day)
|
|
17
|
+
key = signup("you@example.com")
|
|
18
|
+
|
|
19
|
+
# Audit any URL
|
|
20
|
+
result = audit("https://example.com", api_key=key)
|
|
21
|
+
print(f"Score: {result['score']}/100 ({result['grade']})")
|
|
22
|
+
|
|
23
|
+
# See what to fix
|
|
24
|
+
for p in result["priorities"]:
|
|
25
|
+
print(f" [{p['severity']}] {p['issue']}")
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Functions
|
|
29
|
+
|
|
30
|
+
| Function | Description |
|
|
31
|
+
|----------|-------------|
|
|
32
|
+
| `signup(email)` | Get a free API key |
|
|
33
|
+
| `audit(url, api_key)` | Run SEO audit on a URL |
|
|
34
|
+
| `batch_audit(urls, api_key)` | Audit multiple URLs (paid) |
|
|
35
|
+
| `usage(api_key)` | Check your usage/limits |
|
|
36
|
+
| `add_monitor(url, api_key)` | Set up score monitoring (paid) |
|
|
37
|
+
| `list_monitors(api_key)` | List active monitors |
|
|
38
|
+
| `report_url(domain)` | Get shareable report URL |
|
|
39
|
+
|
|
40
|
+
## What Gets Checked
|
|
41
|
+
|
|
42
|
+
28 checks across 5 categories: meta & content, technical SEO, social/OG, performance, accessibility.
|
|
43
|
+
|
|
44
|
+
## Links
|
|
45
|
+
|
|
46
|
+
- [Website & Live Demo](https://seoscoreapi.com)
|
|
47
|
+
- [API Docs](https://seoscoreapi.com/docs)
|
|
48
|
+
- [GitHub Action](https://github.com/SeoScoreAPI/seo-audit-action)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=68.0"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "seoscoreapi"
|
|
7
|
+
version = "1.0.0"
|
|
8
|
+
description = "Python client for SEO Score API — audit any URL for SEO issues with one function call"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = {text = "MIT"}
|
|
11
|
+
requires-python = ">=3.8"
|
|
12
|
+
authors = [{name = "SEO Score API", email = "info@seoscoreapi.com"}]
|
|
13
|
+
dependencies = ["requests>=2.20"]
|
|
14
|
+
keywords = ["seo", "audit", "api", "seo-score", "website-audit", "seo-checker"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 5 - Production/Stable",
|
|
17
|
+
"Intended Audience :: Developers",
|
|
18
|
+
"License :: OSI Approved :: MIT License",
|
|
19
|
+
"Programming Language :: Python :: 3",
|
|
20
|
+
"Topic :: Internet :: WWW/HTTP",
|
|
21
|
+
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
[project.urls]
|
|
25
|
+
Homepage = "https://seoscoreapi.com"
|
|
26
|
+
Documentation = "https://seoscoreapi.com/docs"
|
|
27
|
+
Repository = "https://github.com/SeoScoreAPI/examples"
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
"""
|
|
2
|
+
SEO Score API - Python Client
|
|
3
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
4
|
+
|
|
5
|
+
Audit any URL for SEO issues with one function call.
|
|
6
|
+
|
|
7
|
+
Usage:
|
|
8
|
+
from seoscoreapi import audit, signup
|
|
9
|
+
|
|
10
|
+
# Get a free API key
|
|
11
|
+
key = signup("you@example.com")
|
|
12
|
+
|
|
13
|
+
# Run an audit
|
|
14
|
+
result = audit("https://example.com", api_key=key)
|
|
15
|
+
print(f"Score: {result['score']}/100 ({result['grade']})")
|
|
16
|
+
|
|
17
|
+
Full docs: https://seoscoreapi.com/docs
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
import requests
|
|
21
|
+
|
|
22
|
+
BASE_URL = "https://seoscoreapi.com"
|
|
23
|
+
__version__ = "1.0.0"
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def signup(email: str) -> str:
|
|
27
|
+
"""Sign up for a free API key. Returns the raw key (save it — shown only once)."""
|
|
28
|
+
r = requests.post(f"{BASE_URL}/signup", json={"email": email})
|
|
29
|
+
r.raise_for_status()
|
|
30
|
+
return r.json()["api_key"]
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def audit(url: str, api_key: str) -> dict:
|
|
34
|
+
"""Run an SEO audit on a URL. Returns score, grade, checks, and priorities."""
|
|
35
|
+
r = requests.get(f"{BASE_URL}/audit", params={"url": url}, headers={"X-API-Key": api_key})
|
|
36
|
+
r.raise_for_status()
|
|
37
|
+
return r.json()
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
def batch_audit(urls: list[str], api_key: str) -> dict:
|
|
41
|
+
"""Audit multiple URLs (paid plans only). Returns list of results."""
|
|
42
|
+
r = requests.post(f"{BASE_URL}/audit/batch", json={"urls": urls}, headers={"X-API-Key": api_key})
|
|
43
|
+
r.raise_for_status()
|
|
44
|
+
return r.json()
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
def usage(api_key: str) -> dict:
|
|
48
|
+
"""Check your API usage and limits."""
|
|
49
|
+
r = requests.get(f"{BASE_URL}/usage", headers={"X-API-Key": api_key})
|
|
50
|
+
r.raise_for_status()
|
|
51
|
+
return r.json()
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
def add_monitor(url: str, api_key: str, frequency: str = "daily") -> dict:
|
|
55
|
+
"""Set up score monitoring for a URL (paid plans only)."""
|
|
56
|
+
r = requests.post(f"{BASE_URL}/monitors", json={"url": url, "frequency": frequency}, headers={"X-API-Key": api_key})
|
|
57
|
+
r.raise_for_status()
|
|
58
|
+
return r.json()
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
def list_monitors(api_key: str) -> list:
|
|
62
|
+
"""List your active monitors."""
|
|
63
|
+
r = requests.get(f"{BASE_URL}/monitors", headers={"X-API-Key": api_key})
|
|
64
|
+
r.raise_for_status()
|
|
65
|
+
return r.json()["monitors"]
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
def report_url(domain: str) -> str:
|
|
69
|
+
"""Get the shareable report URL for a domain."""
|
|
70
|
+
return f"{BASE_URL}/report/{domain}"
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: seoscoreapi
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Python client for SEO Score API — audit any URL for SEO issues with one function call
|
|
5
|
+
Author-email: SEO Score API <info@seoscoreapi.com>
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://seoscoreapi.com
|
|
8
|
+
Project-URL: Documentation, https://seoscoreapi.com/docs
|
|
9
|
+
Project-URL: Repository, https://github.com/SeoScoreAPI/examples
|
|
10
|
+
Keywords: seo,audit,api,seo-score,website-audit,seo-checker
|
|
11
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Topic :: Internet :: WWW/HTTP
|
|
16
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
17
|
+
Requires-Python: >=3.8
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
License-File: LICENSE
|
|
20
|
+
Requires-Dist: requests>=2.20
|
|
21
|
+
Dynamic: license-file
|
|
22
|
+
|
|
23
|
+
# seoscoreapi
|
|
24
|
+
|
|
25
|
+
Python client for [SEO Score API](https://seoscoreapi.com) — audit any URL for SEO issues with one function call.
|
|
26
|
+
|
|
27
|
+
## Install
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pip install seoscoreapi
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Quick Start
|
|
34
|
+
|
|
35
|
+
```python
|
|
36
|
+
from seoscoreapi import audit, signup
|
|
37
|
+
|
|
38
|
+
# Get a free API key (5 audits/day)
|
|
39
|
+
key = signup("you@example.com")
|
|
40
|
+
|
|
41
|
+
# Audit any URL
|
|
42
|
+
result = audit("https://example.com", api_key=key)
|
|
43
|
+
print(f"Score: {result['score']}/100 ({result['grade']})")
|
|
44
|
+
|
|
45
|
+
# See what to fix
|
|
46
|
+
for p in result["priorities"]:
|
|
47
|
+
print(f" [{p['severity']}] {p['issue']}")
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Functions
|
|
51
|
+
|
|
52
|
+
| Function | Description |
|
|
53
|
+
|----------|-------------|
|
|
54
|
+
| `signup(email)` | Get a free API key |
|
|
55
|
+
| `audit(url, api_key)` | Run SEO audit on a URL |
|
|
56
|
+
| `batch_audit(urls, api_key)` | Audit multiple URLs (paid) |
|
|
57
|
+
| `usage(api_key)` | Check your usage/limits |
|
|
58
|
+
| `add_monitor(url, api_key)` | Set up score monitoring (paid) |
|
|
59
|
+
| `list_monitors(api_key)` | List active monitors |
|
|
60
|
+
| `report_url(domain)` | Get shareable report URL |
|
|
61
|
+
|
|
62
|
+
## What Gets Checked
|
|
63
|
+
|
|
64
|
+
28 checks across 5 categories: meta & content, technical SEO, social/OG, performance, accessibility.
|
|
65
|
+
|
|
66
|
+
## Links
|
|
67
|
+
|
|
68
|
+
- [Website & Live Demo](https://seoscoreapi.com)
|
|
69
|
+
- [API Docs](https://seoscoreapi.com/docs)
|
|
70
|
+
- [GitHub Action](https://github.com/SeoScoreAPI/seo-audit-action)
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
requests>=2.20
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
seoscoreapi
|