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 Engines 🔎

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.22.tar.gz (13.9 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.22-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: index_now_for_python-1.0.22.tar.gz
  • Upload date:
  • Size: 13.9 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.22.tar.gz
Algorithm Hash digest
SHA256 e67f8d06b09be0e81d2640126f9c416841b7002fbce3f6ae5da1a6278a835db2
MD5 b588df18aeb8eba6c1cd5ef855456b05
BLAKE2b-256 6aa29d408f6ee29e5a20c1d551d71c4323e31569bbb51e215e9e6d54fa8c8931

See more details on using hashes here.

Provenance

The following attestation bundles were made for index_now_for_python-1.0.22.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.22-py3-none-any.whl.

File metadata

File hashes

Hashes for index_now_for_python-1.0.22-py3-none-any.whl
Algorithm Hash digest
SHA256 714132f03754d98ea1bb8c2debcd3a55340fa6132b504943f36eab91067c451c
MD5 a21dac81e14cb902276c6eba2c9cdc4b
BLAKE2b-256 6ed56207a4b4ca6be638362e42ed571de5950a21d5bb8582ff12e7a6195a5220

See more details on using hashes here.

Provenance

The following attestation bundles were made for index_now_for_python-1.0.22-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