Skip to main content

A wrapper library for ORM-like SQL builder and executor

Project description

Algoseek Connector

Documentation Status example workflow

A wrapper library for ORM-like SQL builder and executor. The library provides a simple pythonic interface to algoseek datasets with custom data filtering/selection.

Supported Features

The following query operations on datasets are supported:

  • Selecting columns and arbitrary expressions based on columns
  • Filtering by column value/column expression
  • Grouping by column(s)
  • Sorting by column(s)
  • All common arithmetic, logical operations on dataset columns and function application
  • Fetching query results as a pandas DataFrame

Installation

algoseek-connector is available on the Python Package Index. Install it using the pip command:

pip install algoseek-connector

Documentation

Documentation is available here.

Dev installation

algoseek-connector is installed using Poetry.

A Makefile recipe is available to install the package in developer mode along with developer dependencies:

make dev-install

If make is not available, run:

poetry install --with dev,docs
pre-commit install

Testing

Refer to the README inside the tests directory.

Building the docs

The documentation is generated using the sphinx library. First, install the necessary dependencies with the following command:

poetry install --with docs

Build the documentation using the Makefile located in the docs directory:

make html

Publishing to pypi

In order to pubish a new package version to pypi:

  • update library version in pyproject.toml (note, we use semantic versioning with where version numbers correspond to major, minor and patch)
  • run poetry build to create a package
  • configure your pypi credentials for poetry with poetry config http-basic.pypi <username> <password>
  • run poetry publish to publish the library to PyPI

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

algoseek_connector-2.1.4.tar.gz (33.9 kB view details)

Uploaded Source

Built Distribution

algoseek_connector-2.1.4-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

Details for the file algoseek_connector-2.1.4.tar.gz.

File metadata

  • Download URL: algoseek_connector-2.1.4.tar.gz
  • Upload date:
  • Size: 33.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.1 Linux/6.5.0-1023-azure

File hashes

Hashes for algoseek_connector-2.1.4.tar.gz
Algorithm Hash digest
SHA256 d15a24f1159ee05d309eaa996503c428c3c15d7779681ad853423d05bac426a0
MD5 462b4b701c3a7398df7050a91fc30a2d
BLAKE2b-256 9e810bcf4c35ec563d9b21bee902b4ec7dc68a5dd1fe92c7c9e3485555205703

See more details on using hashes here.

File details

Details for the file algoseek_connector-2.1.4-py3-none-any.whl.

File metadata

  • Download URL: algoseek_connector-2.1.4-py3-none-any.whl
  • Upload date:
  • Size: 43.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.1 Linux/6.5.0-1023-azure

File hashes

Hashes for algoseek_connector-2.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 41a85f4ca7181684a6dce335380f379c09be66575e1a5b02d49495a91c68be81
MD5 1fd25f417e7be81b8bd6a5a77f6b3057
BLAKE2b-256 ac2e94e89a3305f83ae47c81f7d1ea723ec7aab60e33e15f5370be639914feb6

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