seoscoreapi 1.0.0__tar.gz → 1.2.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.
Files changed (11) hide show
  1. {seoscoreapi-1.0.0/seoscoreapi.egg-info → seoscoreapi-1.2.0}/PKG-INFO +7 -21
  2. {seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/README.md +5 -15
  3. {seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/pyproject.toml +4 -6
  4. {seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/seoscoreapi/__init__.py +42 -7
  5. {seoscoreapi-1.0.0 → seoscoreapi-1.2.0/seoscoreapi.egg-info}/PKG-INFO +7 -21
  6. {seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/seoscoreapi.egg-info/SOURCES.txt +0 -1
  7. seoscoreapi-1.0.0/LICENSE +0 -17
  8. {seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/seoscoreapi.egg-info/dependency_links.txt +0 -0
  9. {seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/seoscoreapi.egg-info/requires.txt +0 -0
  10. {seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/seoscoreapi.egg-info/top_level.txt +0 -0
  11. {seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/setup.cfg +0 -0
{seoscoreapi-1.0.0/seoscoreapi.egg-info → seoscoreapi-1.2.0}/PKG-INFO RENAMED
@@ -1,24 +1,20 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: seoscoreapi
3
- Version: 1.0.0
3
+ Version: 1.2.0
4
4
  Summary: Python client for SEO Score API — audit any URL for SEO issues with one function call
5
5
  Author-email: SEO Score API <info@seoscoreapi.com>
6
6
  License: MIT
7
7
  Project-URL: Homepage, https://seoscoreapi.com
8
8
  Project-URL: Documentation, https://seoscoreapi.com/docs
9
- Project-URL: Repository, https://github.com/SeoScoreAPI/examples
9
+ Project-URL: Repository, https://github.com/avansledright/seoscoreapi.com
10
10
  Keywords: seo,audit,api,seo-score,website-audit,seo-checker
11
11
  Classifier: Development Status :: 5 - Production/Stable
12
12
  Classifier: Intended Audience :: Developers
13
13
  Classifier: License :: OSI Approved :: MIT License
14
14
  Classifier: Programming Language :: Python :: 3
15
- Classifier: Topic :: Internet :: WWW/HTTP
16
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
17
15
  Requires-Python: >=3.8
18
16
  Description-Content-Type: text/markdown
19
- License-File: LICENSE
20
17
  Requires-Dist: requests>=2.20
21
- Dynamic: license-file
22
18
 
23
19
  # seoscoreapi
24
20
 
@@ -38,33 +34,23 @@ from seoscoreapi import audit, signup
38
34
  # Get a free API key (5 audits/day)
39
35
  key = signup("you@example.com")
40
36
 
41
- # Audit any URL
37
+ # Run an audit
42
38
  result = audit("https://example.com", api_key=key)
43
39
  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
40
  ```
49
41
 
50
42
  ## Functions
51
43
 
52
44
  | Function | Description |
53
- |----------|-------------|
45
+ |---|---|
54
46
  | `signup(email)` | Get a free API key |
55
47
  | `audit(url, api_key)` | Run SEO audit on a URL |
56
48
  | `batch_audit(urls, api_key)` | Audit multiple URLs (paid) |
57
- | `usage(api_key)` | Check your usage/limits |
49
+ | `usage(api_key)` | Check usage and limits |
58
50
  | `add_monitor(url, api_key)` | Set up score monitoring (paid) |
59
51
  | `list_monitors(api_key)` | List active monitors |
60
52
  | `report_url(domain)` | Get shareable report URL |
61
53
 
62
- ## What Gets Checked
63
-
64
- 28 checks across 5 categories: meta & content, technical SEO, social/OG, performance, accessibility.
65
-
66
- ## Links
54
+ ## Full Documentation
67
55
 
68
- - [Website & Live Demo](https://seoscoreapi.com)
69
- - [API Docs](https://seoscoreapi.com/docs)
70
- - [GitHub Action](https://github.com/SeoScoreAPI/seo-audit-action)
56
+ [seoscoreapi.com/docs](https://seoscoreapi.com/docs)
{seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/README.md RENAMED
@@ -16,33 +16,23 @@ from seoscoreapi import audit, signup
16
16
  # Get a free API key (5 audits/day)
17
17
  key = signup("you@example.com")
18
18
 
19
- # Audit any URL
19
+ # Run an audit
20
20
  result = audit("https://example.com", api_key=key)
21
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
22
  ```
27
23
 
28
24
  ## Functions
29
25
 
30
26
  | Function | Description |
31
- |----------|-------------|
27
+ |---|---|
32
28
  | `signup(email)` | Get a free API key |
33
29
  | `audit(url, api_key)` | Run SEO audit on a URL |
34
30
  | `batch_audit(urls, api_key)` | Audit multiple URLs (paid) |
35
- | `usage(api_key)` | Check your usage/limits |
31
+ | `usage(api_key)` | Check usage and limits |
36
32
  | `add_monitor(url, api_key)` | Set up score monitoring (paid) |
37
33
  | `list_monitors(api_key)` | List active monitors |
38
34
  | `report_url(domain)` | Get shareable report URL |
39
35
 
40
- ## What Gets Checked
41
-
42
- 28 checks across 5 categories: meta & content, technical SEO, social/OG, performance, accessibility.
43
-
44
- ## Links
36
+ ## Full Documentation
45
37
 
46
- - [Website & Live Demo](https://seoscoreapi.com)
47
- - [API Docs](https://seoscoreapi.com/docs)
48
- - [GitHub Action](https://github.com/SeoScoreAPI/seo-audit-action)
38
+ [seoscoreapi.com/docs](https://seoscoreapi.com/docs)
{seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/pyproject.toml RENAMED
@@ -1,27 +1,25 @@
1
1
  [build-system]
2
- requires = ["setuptools>=68.0"]
2
+ requires = ["setuptools>=68.0", "wheel"]
3
3
  build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "seoscoreapi"
7
- version = "1.0.0"
7
+ version = "1.2.0"
8
8
  description = "Python client for SEO Score API — audit any URL for SEO issues with one function call"
9
9
  readme = "README.md"
10
10
  license = {text = "MIT"}
11
11
  requires-python = ">=3.8"
12
12
  authors = [{name = "SEO Score API", email = "info@seoscoreapi.com"}]
13
- dependencies = ["requests>=2.20"]
14
13
  keywords = ["seo", "audit", "api", "seo-score", "website-audit", "seo-checker"]
15
14
  classifiers = [
16
15
  "Development Status :: 5 - Production/Stable",
17
16
  "Intended Audience :: Developers",
18
17
  "License :: OSI Approved :: MIT License",
19
18
  "Programming Language :: Python :: 3",
20
- "Topic :: Internet :: WWW/HTTP",
21
- "Topic :: Software Development :: Libraries :: Python Modules",
22
19
  ]
20
+ dependencies = ["requests>=2.20"]
23
21
 
24
22
  [project.urls]
25
23
  Homepage = "https://seoscoreapi.com"
26
24
  Documentation = "https://seoscoreapi.com/docs"
27
- Repository = "https://github.com/SeoScoreAPI/examples"
25
+ Repository = "https://github.com/avansledright/seoscoreapi.com"
{seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/seoscoreapi/__init__.py RENAMED
@@ -17,54 +17,89 @@ Usage:
17
17
  Full docs: https://seoscoreapi.com/docs
18
18
  """
19
19
 
20
+ from typing import Optional
21
+
20
22
  import requests
21
23
 
22
24
  BASE_URL = "https://seoscoreapi.com"
23
- __version__ = "1.0.0"
25
+ __version__ = "1.2.0"
26
+
27
+ _HEADERS = {"User-Agent": f"seoscoreapi-python/{__version__}"}
24
28
 
25
29
 
26
30
  def signup(email: str) -> str:
27
31
  """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})
32
+ r = requests.post(f"{BASE_URL}/signup", json={"email": email}, headers=_HEADERS)
29
33
  r.raise_for_status()
30
34
  return r.json()["api_key"]
31
35
 
32
36
 
33
37
  def audit(url: str, api_key: str) -> dict:
34
38
  """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})
39
+ r = requests.get(f"{BASE_URL}/audit", params={"url": url}, headers={"X-API-Key": api_key, **_HEADERS})
36
40
  r.raise_for_status()
37
41
  return r.json()
38
42
 
39
43
 
40
44
  def batch_audit(urls: list[str], api_key: str) -> dict:
41
45
  """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})
46
+ r = requests.post(f"{BASE_URL}/audit/batch", json={"urls": urls}, headers={"X-API-Key": api_key, **_HEADERS})
43
47
  r.raise_for_status()
44
48
  return r.json()
45
49
 
46
50
 
47
51
  def usage(api_key: str) -> dict:
48
52
  """Check your API usage and limits."""
49
- r = requests.get(f"{BASE_URL}/usage", headers={"X-API-Key": api_key})
53
+ r = requests.get(f"{BASE_URL}/usage", headers={"X-API-Key": api_key, **_HEADERS})
50
54
  r.raise_for_status()
51
55
  return r.json()
52
56
 
53
57
 
54
58
  def add_monitor(url: str, api_key: str, frequency: str = "daily") -> dict:
55
59
  """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})
60
+ r = requests.post(f"{BASE_URL}/monitors", json={"url": url, "frequency": frequency}, headers={"X-API-Key": api_key, **_HEADERS})
57
61
  r.raise_for_status()
58
62
  return r.json()
59
63
 
60
64
 
61
65
  def list_monitors(api_key: str) -> list:
62
66
  """List your active monitors."""
63
- r = requests.get(f"{BASE_URL}/monitors", headers={"X-API-Key": api_key})
67
+ r = requests.get(f"{BASE_URL}/monitors", headers={"X-API-Key": api_key, **_HEADERS})
64
68
  r.raise_for_status()
65
69
  return r.json()["monitors"]
66
70
 
67
71
 
72
+ def scoreboard_opt_out(api_key: str, opt_out: bool = True) -> dict:
73
+ """Opt in or out of the public SEO scoreboard."""
74
+ r = requests.put(f"{BASE_URL}/scoreboard/opt-out", params={"opt_out": str(opt_out).lower()}, headers={"X-API-Key": api_key, **_HEADERS})
75
+ r.raise_for_status()
76
+ return r.json()
77
+
78
+
79
+ def competitive_audit(url: str, competitor_url: str, keyword: str, api_key: str) -> dict:
80
+ """Run a head-to-head competitive audit (Pro plan or higher). Returns gap score, per-check diffs, and action items."""
81
+ r = requests.post(f"{BASE_URL}/audit/competitive", json={"url": url, "competitor_url": competitor_url, "keyword": keyword}, headers={"X-API-Key": api_key, **_HEADERS})
82
+ r.raise_for_status()
83
+ return r.json()
84
+
85
+
68
86
  def report_url(domain: str) -> str:
69
87
  """Get the shareable report URL for a domain."""
70
88
  return f"{BASE_URL}/report/{domain}"
89
+
90
+
91
+ def history(url: str, api_key: str, limit: int = 100, since: Optional[float] = None) -> dict:
92
+ """Get historical audit scores and trend summary for a URL (Starter plan or higher)."""
93
+ params: dict = {"url": url, "limit": limit}
94
+ if since is not None:
95
+ params["since"] = since
96
+ r = requests.get(f"{BASE_URL}/history", params=params, headers={"X-API-Key": api_key, **_HEADERS})
97
+ r.raise_for_status()
98
+ return r.json()
99
+
100
+
101
+ def history_domains(api_key: str) -> list:
102
+ """List every domain audited by this key with latest score and 30-day trend (Starter plan or higher)."""
103
+ r = requests.get(f"{BASE_URL}/history/domains", headers={"X-API-Key": api_key, **_HEADERS})
104
+ r.raise_for_status()
105
+ return r.json()["domains"]
{seoscoreapi-1.0.0 → seoscoreapi-1.2.0/seoscoreapi.egg-info}/PKG-INFO RENAMED
@@ -1,24 +1,20 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: seoscoreapi
3
- Version: 1.0.0
3
+ Version: 1.2.0
4
4
  Summary: Python client for SEO Score API — audit any URL for SEO issues with one function call
5
5
  Author-email: SEO Score API <info@seoscoreapi.com>
6
6
  License: MIT
7
7
  Project-URL: Homepage, https://seoscoreapi.com
8
8
  Project-URL: Documentation, https://seoscoreapi.com/docs
9
- Project-URL: Repository, https://github.com/SeoScoreAPI/examples
9
+ Project-URL: Repository, https://github.com/avansledright/seoscoreapi.com
10
10
  Keywords: seo,audit,api,seo-score,website-audit,seo-checker
11
11
  Classifier: Development Status :: 5 - Production/Stable
12
12
  Classifier: Intended Audience :: Developers
13
13
  Classifier: License :: OSI Approved :: MIT License
14
14
  Classifier: Programming Language :: Python :: 3
15
- Classifier: Topic :: Internet :: WWW/HTTP
16
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
17
15
  Requires-Python: >=3.8
18
16
  Description-Content-Type: text/markdown
19
- License-File: LICENSE
20
17
  Requires-Dist: requests>=2.20
21
- Dynamic: license-file
22
18
 
23
19
  # seoscoreapi
24
20
 
@@ -38,33 +34,23 @@ from seoscoreapi import audit, signup
38
34
  # Get a free API key (5 audits/day)
39
35
  key = signup("you@example.com")
40
36
 
41
- # Audit any URL
37
+ # Run an audit
42
38
  result = audit("https://example.com", api_key=key)
43
39
  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
40
  ```
49
41
 
50
42
  ## Functions
51
43
 
52
44
  | Function | Description |
53
- |----------|-------------|
45
+ |---|---|
54
46
  | `signup(email)` | Get a free API key |
55
47
  | `audit(url, api_key)` | Run SEO audit on a URL |
56
48
  | `batch_audit(urls, api_key)` | Audit multiple URLs (paid) |
57
- | `usage(api_key)` | Check your usage/limits |
49
+ | `usage(api_key)` | Check usage and limits |
58
50
  | `add_monitor(url, api_key)` | Set up score monitoring (paid) |
59
51
  | `list_monitors(api_key)` | List active monitors |
60
52
  | `report_url(domain)` | Get shareable report URL |
61
53
 
62
- ## What Gets Checked
63
-
64
- 28 checks across 5 categories: meta & content, technical SEO, social/OG, performance, accessibility.
65
-
66
- ## Links
54
+ ## Full Documentation
67
55
 
68
- - [Website & Live Demo](https://seoscoreapi.com)
69
- - [API Docs](https://seoscoreapi.com/docs)
70
- - [GitHub Action](https://github.com/SeoScoreAPI/seo-audit-action)
56
+ [seoscoreapi.com/docs](https://seoscoreapi.com/docs)
{seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/seoscoreapi.egg-info/SOURCES.txt RENAMED
@@ -1,4 +1,3 @@
1
- LICENSE
2
1
  README.md
3
2
  pyproject.toml
4
3
  seoscoreapi/__init__.py
seoscoreapi-1.0.0/LICENSE DELETED
@@ -1,17 +0,0 @@
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.
{seoscoreapi-1.0.0 → seoscoreapi-1.2.0}/setup.cfg RENAMED
File without changes