Skip to main content

A small Python library for accessing the SyntaxDB API

Project description

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 documentation of the API can be found at https://syntaxdb.com/api/v1.

Installation

pip install syntaxdb

Usage

import syntaxdb

Authentication

Authentication is not required for the usage of the API.

Queries

First is an example:

import syntadb

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 neccessary).

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 simple add exactly parameters mentioned in the doc (pay attention to required parameters), then call concept(), language() or category().

Contributing

Bug reports and pull requests are welcome 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.

Files for syntaxdb, version 0.0.5
Filename, size File type Python version Upload date Hashes
Filename, size syntaxdb-0.0.5.tar.gz (3.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page