Skip to main content

Search in API

https://img.shields.io/pypi/v/search_in_api.svg https://img.shields.io/travis/archatas/search_in_api.svg Updates Documentation Status

Search in API is a tool helping to debug import scripts or export APIs. It allows you to search for a specific tag and value among multiple pages of an XML API endpoint or key and value among multiple pages of a JSON API endpoint.

Use Case Example

Let’s say, you have an XML API that provides a playlist of songs. It’s a looooong paginated list and there is no search implemented. You have an urge to find that particular song with a title having a word “Journey” and to check who is playing it. If the songs are listed chronologically by the date added, you would need to search from page to page until you finally get it. This tool does exactly that for you. There you can enter the URL of the first page of XML API or JSON API, enter the tag or key “title”, and the value “Journey”, and a few moments later it will show you the page URLs of the API that contain songs with the word “Journey” in it.

XML and JSON API Endpoints

The XML API endpoint should necessarily have /meta/next/ node defining the URL of the next page as in this XML example.

Similarly the JSON API endpoint should necessarily have the ['meta']['next'] key defining the URL of the next page as in this JSON example.

Features

  • Search for pages with specific occurrences of tag/key and value in multi-page XML or JSON API endpoint.

  • Command-line and graphical user interface.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

1.0.0 (2020-02-05)

  • Python 2 support dropped.

0.7.0 (2019-01-24)

  • Supports both, XML and JSON, API endpoints.

0.1.0 (2018-03-09)

  • First release on PyPI.

Metadata

Release files for search-in-api 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for search-in-api 1.0.1
File Size Uploaded
search_in_api-1.0.1.tar.gz 14.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for search-in-api 1.0.1
File Interpreter ABI Platform
search_in_api-1.0.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 21.8 kB

Release files / search_in_api-1.0.1.tar.gz

Download URL search_in_api-1.0.1.tar.gz
Size 14.6 kB
Tags Source
SHA-256 checksum
How to use checksums
7e4e3d45380cec28ae39634ade70eeba79d285cf5ac7d663f1343e18a7378722
BLAKE2b-256 checksum
How to use checksums
eeefcb845fdab03bb0eca54182dd0a34fb35444d4cd1c496f1ed0ebd83ed1dda
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7

Release files / search_in_api-1.0.1-py2.py3-none-any.whl

Download URL search_in_api-1.0.1-py2.py3-none-any.whl
Size 7.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
688e860e10e6d91a1eba9b6af211b155c355451ef3fcba6a635bf1ea5be67543
BLAKE2b-256 checksum
How to use checksums
50893b884a6930344c8cef6c014c838a83efa3a7fc8abf8524b2a1050c85561f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.6.7

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page