Metadata-Version: 2.1
Name: tmlt.analytics
Version: 0.3.0
Summary: Tumult's differential privacy analytics API
Requires-Python: >=3.7.1,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: numpy (>=1.18.0,<1.19.5)
Requires-Dist: pandas (>=1.2.0,<2.0.0)
Requires-Dist: pyarrow (>=2.0.0,<3.0.0)
Requires-Dist: pyspark[sql] (>=3.0.0,<3.1.0)
Requires-Dist: sympy (>=1.8,<1.10)
Requires-Dist: tmlt.core (>=0.3.1,<0.4.0)
Requires-Dist: typeguard (>=2.12.1,<2.13.0)
Description-Content-Type: text/markdown

# Tumult Analytics

Tumult Analytics is a library that allows users to execute differentially private operations on
data without having to worry about the privacy implementation, which is handled
automatically by the API. It is built atop the [Tumult Core library](https://gitlab.com/tumult-labs/core).

## Installation

See the [installation instructions in the documentation](https://docs.tmlt.dev/analytics/latest/installation.html#prerequisites)
for information about setting up prerequisites such as Spark and python-flint.

Once the prerequisites are installed, you can install Tumult Analytics using [pip](https://pypi.org/project.pip).

```bash
pip install tmlt.analytics
```

## Documentation

The full documentation is located at https://docs.tmlt.dev/analytics/latest/.

## Support

If you have any questions/concerns, please [create an issue](https://gitlab.com/tumult-labs/analytics/-/issues) or reach out to [support@tmlt.io](mailto:support@tmlt.io)

## Contributing

We are not yet accepting external contributions, but please let us know at [support@tmlt.io](mailto:support@tmlt.io) if you are interested in contributing.

See [CONTRIBUTING.md](CONTRIBUTING.md) for information about installing our development dependencies and running tests.

## License


The Tumult Platform source code is licensed under the Apache License, version 2.0 (Apache-2.0).
The Tumult Platform documentation is licensed under 
Creative Commons Attribution-ShareAlike 4.0 International (CC-BY-SA-4.0).

