Bing APIs SDK for Python

This repository is for active development of the Bing APIs SDK for Python. For consumers of the SDK we recommend visiting our public developer docs

Table of Contents

• Bing APIs SDK for Python
  • Features
    • PyPi Packages
  • Getting started
    • Structure
    • Prerequisites
    • Requiremnts
    • Running Samples
    • Running Tests
  • Need help?
  • Contributing
  • Resources
  • Related Projects
  • Code of Conduct
  • Trademarks
  • License
  • Security

Features

This project includes the following Bing-Search-APIs Python components:

• REST API samples and tests
• SDK Implementation
• SDK Samples

It also contains CI/CD actions for test and deployment

This repo is actively maintained and issues / PRs are regularly looked-on

PyPi Packages

This repo contains the implementations for the following packages

• Autosuggest
• Custom Image Search
• Custom Web Search
• Entity Search
• Image Search
• News Search
• Spell Check
• Video Search
• Visual Search
• Web Search

Getting started

To get started with a specific library, see the README.md file located in the library's project folder

You can find service libraries in the /sdk directory

Structure

Directory (click to navigate)	Description
samples/	Directory containing all the code samples
samples/rest/	Directory containing all the REST code samples
samples/sdk/	Directory containing all the SDK code samples
sdk/	Directory containing the SDK libraries
sdk/Autosuggest	Autosuggest SDK library
sdk/CustomImageSearch	Custom Image Search SDK library
sdk/CustomWebSearch	Custom Web Search SDK library
sdk/EntitySearch	Entity Search SDK library
sdk/ImageSearch	Image Search SDK library
sdk/NewsSearch	News Search SDK library
sdk/SpellCheck	Spell Check SDK library
sdk/VideoSearch	Video Search SDK library
sdk/VisualSearch	Visual Search SDK library
sdk/WebSearch	Web Search SDK library
tests/	Directory containing all the tests
tests/rest	Directory containing tests for REST samples

Prerequisites

• Python 2.7, or 3.5 or later is required to use this package
• Bing APIs Resouce on Azure
  • Create a .env file using .env.example as reference and fill it using your aquired credentials

Requiremnts

See requirements.txt

Running Samples

1. Clone the repo

2. (Optional) Create your virtual environment

3. Install dependencies

   pip install requirements.txt
   

4. Create a .env file and fill it using .env.example as guidance

5. Run the file you want

   python ./samples/rest/*.py
   

Running Tests

1. Clone the repo

2. (Optional) Create a virtual environment

3. Install dependencies, e.g.:

   pip install requirements.txt
   pip install tests/test-requirements.txt
   

4. Create a .env file and fill it using .env.example as guidance

5. Run all the tests:

   pytest
   

Need help?

See Support

Contributing

See Contributing guide

Resources

• Bing APIs for documentation
• Github Issues

Related Projects

• .NET SDK and Samples repo
• Java SDK and Samples repo

Code of Conduct

See Code of Conduct

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship Any use of third-party trademarks or logos are subject to those third-party's policies

License

See LICENSE

Security

See Security