Skip to main content

Sketch Grammar Explorer (Sketch Engine API wrapper)

Project description

Sketch Grammar Explorer

PyPI Latest Release PyPI - Python Versions Package Status License DOI

Introduction

Sketch Grammar Explorer is an API wrapper for Sketch Engine, a corpus management software useful for linguistic research. The goal is to build a flexible scaffold for any kind of programmatic work with Sketch Engine and NoSketch Engine.

Installation

Clone SGEX or install it with pip install sgex (main dependencies are pandas pyyaml aiohttp aiofiles).

Get a Sketch Engine API key. Be sure to reference SkE's documentation and schema:

wget https://www.sketchengine.eu/apidoc/openapi.yaml -O .openapi.yaml

Getting started

A quick intro on the API (examples use a local NoSketch Engine server).

Most things are identical for SkE's main server, apart from using credentials and more call types being available. SGEX currently uses the Bonito API, with URLs ending in /bonito/run.cgi, not newer paths like /search/corp_info.

Package modules

  • job: the primary module - makes requests and manipulates data
  • call: classes and methods for API call types
  • query: functions to generate/manipulate CQL queries
  • util: utility functions

The Job class

Calls are made with the job module, which can also be run as a script. The Job class has a few options:

from sgex.job import Job

j = Job(
	# define API calls
	infile: str | list | None = None,
	params: str | dict | list | None = None,
	# set server info
	server: str = "local",
	default_servers: dict = default_servers,
	# supply credentials
	api_key: str | None = None,
	username: str | None = None,
	# manage caching
	cache_dir: str = "data",
	clear_cache: bool = False,
	# run asynchronous requests
	thread: bool = False,
	# control request throttling
	wait_dict: dict = wait_dict,
	# make a dry run
	dry_run: bool = False,
	# change verbosity
	verbose: bool = False,
	)

j.run()

See the code repository for full documentation.

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

sgex-0.7.5.tar.gz (35.5 kB view details)

Uploaded Source

Built Distribution

sgex-0.7.5-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file sgex-0.7.5.tar.gz.

File metadata

  • Download URL: sgex-0.7.5.tar.gz
  • Upload date:
  • Size: 35.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for sgex-0.7.5.tar.gz
Algorithm Hash digest
SHA256 e0025f97fe0116c2cde8eb402a4ecd37a2bf062232fd9110b5d5d23ace149771
MD5 94b6d2661c3f308b796d384d2559225c
BLAKE2b-256 3c283b3aac3b3b4abac0e074608e4322802d9fea0bc970b68cc52e012cd4d69a

See more details on using hashes here.

File details

Details for the file sgex-0.7.5-py3-none-any.whl.

File metadata

  • Download URL: sgex-0.7.5-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for sgex-0.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 61896dfc53156daf045cd2f0b7a985e6163127a400bd4992df826ca7f3c444f1
MD5 04d5a49ddacb07fe1e349803f40934a7
BLAKE2b-256 825d50b14e089770eacfee3d591317a4fb75b70424742beced18d8e30bfe616e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page