Skip to main content

A small Python library for accessing the SyntaxDB API

Project description

Build Status

This is a small Python library for accessing the SyntaxDB API.

SyntaxDB is a programing language syntax database. See https://syntaxdb.com/about for more infomation.

Official document of the API can be found at https://syntaxdb.com/api/v1.

Installation

pip install syntaxdb

Usage

import syntaxdb

Authentication

The usage of the API doesn’t require any authentication.

Queries

First, there is an example:

import syntaxdb

db = syntaxdb.syntaxdb()

#add parameters if neccessary:
db.parameters['language_permalink'] = 'python'

#query concepts of language (here is Python):
db.concept()

Before executing some queries, we need to add the parameters (if necessary).

db.parameters['parameter_name'] = value

Then call concept(), language(), category() to get what we want (in the example we get all concepts corresponding to Python).

After finishing query, we can change parameters to make another query.

See parameters list in API’s document: https://syntaxdb.com/api/v1.

More detail about operations, parameter’s type, required parameters, response content type … can be found at the API documentation too.

To query an operation (listed in the API doc), we just simply add parameters mentioned in the doc (pay attention to required parameters), then call concept(), language() or category().

Changelog:

  • 26/2/2017: 0.0.1

    Inital release.
    
    Success build with Travis.
    
    Pip support.
    
  • 9/3/2017: 0.0.6

    Fix bug: function name "addparameters".
    
  • 8/5/2017: 0.1.2

    Add Python3 support.
    

Contributing

Bug reports and pull requests are welcomed at https://github.com/lhat-messorem/syntax_db.

License

This library is a open source software licensed under the MIT License. Details provided in the LICENSE file.

SyntaxDB API copyrights © 2017 SyntaxDB

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
syntaxdb-0.1.2.tar.gz (3.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page