Metadata-Version: 2.4
Name: onetick-py
Version: 1.170.0
Summary: Python package that allows you to work with OneTick
Author-email: solutions <solutions@onetick.com>
License-Expression: MIT
Project-URL: Documentation, https://docs.pip.distribution.sol.onetick.com
Project-URL: OneTick, https://onetick.com
Project-URL: GitHub, https://github.com/onemarketdata/onetick-py
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas==1.1.5; python_version == "3.6"
Requires-Dist: pandas==1.3.4; python_version == "3.7"
Requires-Dist: pandas<2.1.0,>=1.3.4; python_version == "3.8"
Requires-Dist: pandas<2.3.0,>=1.3.4; python_version == "3.9"
Requires-Dist: pandas<2.3.0,>=1.5.1; python_version == "3.10"
Requires-Dist: pandas<2.3.0,>=1.5.3; python_version == "3.11"
Requires-Dist: pandas<2.3.0,>=2.2.0; python_version >= "3.12"
Requires-Dist: pyarrow; python_version >= "3.12"
Requires-Dist: numpy==1.19.5; python_version <= "3.7"
Requires-Dist: numpy==1.21.6; python_version == "3.8"
Requires-Dist: numpy<2.3.0,>=1.20.3; python_version >= "3.9"
Requires-Dist: coolname
Requires-Dist: python-dateutil
Requires-Dist: python-dotenv
Requires-Dist: tzlocal
Requires-Dist: tzdata
Requires-Dist: backports.zoneinfo==0.2.1; python_version < "3.9"
Requires-Dist: typing_extensions==4.7.1; python_version < "3.8"
Requires-Dist: singledispatchmethod==1.0; python_version < "3.8"
Requires-Dist: backports.cached-property==1.0.2; python_version <= "3.8"
Requires-Dist: backports.functools-lru-cache==1.6.6; python_version <= "3.8"
Requires-Dist: astunparse==1.6.3; python_version <= "3.8"
Requires-Dist: graphviz==0.20.1; python_version > "3.6"
Requires-Dist: packaging>=21.0
Provides-Extra: strict
Requires-Dist: numpy==1.19.5; python_version <= "3.7" and extra == "strict"
Requires-Dist: numpy==1.21.6; python_version == "3.8" and extra == "strict"
Requires-Dist: numpy==1.23.0; (python_version >= "3.9" and python_version <= "3.10") and extra == "strict"
Requires-Dist: numpy==1.26.4; (python_version >= "3.11" and python_version <= "3.12") and extra == "strict"
Requires-Dist: pandas==1.1.5; python_version == "3.6" and extra == "strict"
Requires-Dist: pandas==1.3.4; (python_version >= "3.7" and python_version <= "3.9") and extra == "strict"
Requires-Dist: pandas==1.5.1; python_version == "3.10" and extra == "strict"
Requires-Dist: pandas==1.5.3; python_version == "3.11" and extra == "strict"
Requires-Dist: pandas==2.2.0; python_version >= "3.12" and extra == "strict"
Provides-Extra: webapi
Requires-Dist: onetick.query_webapi; extra == "webapi"
Provides-Extra: polars
Requires-Dist: polars==1.12.0; extra == "polars"
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist

# Overview

``onetick.py`` is a versatile and efficient Python library designed for handling tick data with ease.
It harnesses the power of OneTick, the industry-leading tick analytics technology, to process tick
data at unparalleled speeds. This library is tailored both for existing OneTick users,
as a Python interface into OneTick, and for new users who seek an intuitive tool for tick data analysis
that comes with tick data from 200+ exchanges.

The primary strength of ``onetick.py`` lies in its similarity to the popular Python library, Pandas.
Users familiar with Pandas find ``onetick.py`` easy to learn. In particular, ``onetick.py`` users
can think in terms of Python expressions, built-ins, and native math operations on tick fields.

``onetick.py`` goes far beyond the functionality that exists in Pandas exposing all of the power of OneTick
(decades of development for the capital markets use cases) in a Pandas-like style. Crucially, the
Pandas-like syntax is translated into the OneTick query language, executing on the high-performance
OneTick tick server engine. In a nutshell, ``onetick.py`` combines the ease of use of Python
with the performance of  OneTick.

## Installation

The latest version of ``onetick-py`` is available on PyPI: <https://pypi.org/project/onetick-py/>.

    pip install onetick-py[webapi]

Use ``webapi`` extra to easily use it with remote OneTick Cloud server.

See [Getting Started](https://docs.pip.distribution.sol.onetick.com/static/getting_started/root.html)
section in the documentation to see how quickly set up ``onetick-py`` configuration
and authentication and start running queries.

For other installation options, including using ``onetick-py`` with locally installed OneTick server,
see [Installation](https://docs.pip.distribution.sol.onetick.com/static/installation/webapi.html)
section in the documentation.

## Key Features

- **Pandas-like API**: Familiar syntax and functions for those accustomed to Pandas.
- **High-Performance**: Executes complex queries rapidly using the underlying OneTick C++ engine.
- **Real-time processing / CEP**: Same intuitive syntax for real-time and historical analytics.
- **Convenient Data Inspection and Testing**: Integrated tools for debugging, data inspection, and testing with pytest.
- **Enterprise-Grade Features**: Includes support for authentication, access control, encryption, and entitlements.
- **Comprehensive Documentation**: Public multiversion documentation with examples, guides, and use cases.

## Applications

- **TCA / BestEx**: Quickly implement your own TCA / BestEx analytics.
- **Quant research**: Ideal for complex, high-performance tick data analysis.
- **Algorithmic Trading**: Efficient for developing and testing trading algorithms.
- **Data Visualization**: Compatible with OneTick's visualization tool, OneTick Dashboard.
- **Machine Learning**: Integrates with the OneTick ML library [onetick-ml](https://dsframework.pip.distribution.sol.onetick.com/intro.html).
- **Industry Applications**: Industry leading OneTick's Trade Surveillance and BestEx/TCA solutions are written in ``onetick.py``.

## Advantages Over Competitors

- **Ease of Use**: The only language that provides the performance of a DSL without having to learn a new syntax.
- **Performance**: Demonstrates superior performance and memory efficiency compared to similar tools.
- **Parallel Processing**: Natively parallelizable by security and by day.
- **Production-Ready**: Ideal for debugging, testing, and CI/CD.

## Ways to use ``onetick.py``

``onetick.py`` can be used to analyze data managed and hosted by OneTick or managed and
hosted by the customer in a local OneTick installation.

### Hosted OneTick

- Hosted OneTick comes with high quality tick data, daily data, and reference data for 200+ global markets.
- OneTick offers T+1 and real-time tick data that is normalized and quality checked.
- OneTick supports a variety of symbologies and handles corporate action adjustments.
- The installation is a simple ``pip install`` (details [here](https://docs.pip.distribution.sol.onetick.com/static/installation/webapi.html)).

### Local OneTick

- Manage all of your market data and order flow in the industry-leading tick management platform OneTick.
- Have your users access and analyze the data via a simple and intuitive ``onetick.py`` API.
- Managed services options are available.
- Installation details are [here](https://docs.pip.distribution.sol.onetick.com/static/installation/onprem.html).

## OneTick

``onetick-py`` is part of a bigger tick management OneTick ecosystem. You may want to turn to OneTick for

- Visual query designer.
- Collecting, loading, and storing tick data.
- Other APIs including C++, C#, Java, R, Matlab.
- Learn more at [onetick.com/onetick-tick-analytics-platform](https://www.onetick.com/onetick-tick-analytics-platform).
