Skip to main content

Lightweight package that makes it easy to submit URLs to the IndexNow API of various search engines

Project description

Latest version Python 3.11 | 3.12 | 3.13 | 3.14+ MIT license Codecov CodeQL Test Downloads

🔍 Submit URLs to the IndexNow API of Various Search Enginges 🔎

Are you concerned about search engine optimization (SEO)? Do you want to make sure your website is indexed frequently by Bing, Yandex, DuckDuckGo, and other search engines?

IndexNow for Python is a lightweight, yet powerful Python package that makes it easy to submit URLs or entire sitemaps to the IndexNow API of various search engines, so your pages can be indexed faster.

Ready to try? Learn how to install and find tutorials in the user guide.

Getting Started

Basic Usage and Submit Individual URLs

Firstly, ensure that you have an API key for IndexNow. Hereafter, add your authentication credentials to the IndexNowAuthentication class, which will be used throughout the examples. You can now submit individual URLs to the IndexNow API:

from index_now import submit_url_to_index_now, IndexNowAuthentication

authentication = IndexNowAuthentication(
    host="example.com",
    api_key="a1b2c3d4",
    api_key_location="https://example.com/a1b2c3d4.txt",
)

submit_url_to_index_now(authentication, "https://example.com/page1")

[!IMPORTANT] Instances of authentication = IndexNowAuthentication(...) below refer to this section:

authentication = IndexNowAuthentication(
    host="example.com",
    api_key="a1b2c3d4",
    api_key_location="https://example.com/a1b2c3d4.txt",
)

Submit Multiple URLs in Bulk

How to submit multiple URLs in bulk to the IndexNow API:

from index_now import submit_urls_to_index_now, IndexNowAuthentication

authentication = IndexNowAuthentication(...)

urls = ["https://example.com/page1", "https://example.com/page2", "https://example.com/page3"]

submit_urls_to_index_now(authentication, urls)

Submit Entire Sitemap

How to submit an entire sitemap to the IndexNow API:

from index_now import submit_sitemap_to_index_now, IndexNowAuthentication

authentication = IndexNowAuthentication(...)

sitemap_location = "https://example.com/sitemap.xml"

submit_sitemap_to_index_now(authentication, sitemap_location)

Submit to Specific Search Engines

How to use the default SearchEngineEndpoint options or a custom endpoint:

from index_now import submit_url_to_index_now, IndexNowAuthentication, SearchEngineEndpoint

authentication = IndexNowAuthentication(...)

endpoint_bing = SearchEngineEndpoint.BING
endpoint_custom = "https://example.com/indexnow"

for endpoint in [endpoint_bing, endpoint_custom]:
    submit_url_to_index_now(authentication, "https://example.com/page1", endpoint)

Become a Sponsor 🏅

If you find this project helpful, please consider supporting its development. Your donations will help keep it alive and growing. Every contribution makes a difference, whether you buy a coffee or support with a monthly donation. Find your tier here:

Donate on GitHub Sponsors

Thank you for your support! 🙌

Contribute

If you have suggestions or changes to the module, feel free to add to the code and create a pull request.

Report Bugs

If you encounter any issues, you can report them as bugs or raise issues.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

index_now_for_python-1.0.20.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

index_now_for_python-1.0.20-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file index_now_for_python-1.0.20.tar.gz.

File metadata

  • Download URL: index_now_for_python-1.0.20.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for index_now_for_python-1.0.20.tar.gz
Algorithm Hash digest
SHA256 68b6af94dedb92b6d4f867496be79e892e1ff618e808e247abf3c77d8a9e141b
MD5 e85fd0cd206e5c5d6daaae9a5c02e5a6
BLAKE2b-256 1b249e4a7f076cd72fa1146e319e380e6ab5eafba5f5be587f61838f9355be35

See more details on using hashes here.

Provenance

The following attestation bundles were made for index_now_for_python-1.0.20.tar.gz:

Publisher: release.yml on jakob-bagterp/index-now-for-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file index_now_for_python-1.0.20-py3-none-any.whl.

File metadata

File hashes

Hashes for index_now_for_python-1.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 2c97524a141e69eadb1689ea8e2daf46b3e727fe728efa7d6a6b8b162ac48fbc
MD5 b6483a9c95ca6f1ba05bf59b1d577048
BLAKE2b-256 102d5d25f137f3e54e500fb27075cdff6591c65ca92b0411fd6d53c9d21ee845

See more details on using hashes here.

Provenance

The following attestation bundles were made for index_now_for_python-1.0.20-py3-none-any.whl:

Publisher: release.yml on jakob-bagterp/index-now-for-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page