Metadata-Version: 2.1
Name: transpose-dit
Version: 0.1.1
Summary: Web3 Data Made Simple. Powerful APIs for accessing human-readable blockchain data at scale: from blocks and transactions to NFTs and tokens.
Home-page: https://github.com/TransposeData/dedicated-instance-tools
Author: Jonathan Becker (jon-becker)
Author-email: jon@transpose.io
License: MIT
Keywords: web3,data,ethereum,web3 data,ethereum data
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Topic :: Database
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
License-File: LICENSE

# Dedicated Instance Tools
![Deployment Tests](https://github.com/TransposeData/transpose-python-sdk/actions/workflows/deployment_tests.yml/badge.svg) ![PyPI version](https://badge.fury.io/py/transpose-dit.svg) ![Installations](https://img.shields.io/pypi/dd/transpose-dit?color=g)

Python utilities for working with Transpose Dedicated Instances.

## Getting Started

First, install the package from PyPI:

```bash
pip install transpose-dit
```

Then, connecting to your dedicated instance is as easy as

```python
from transpose_dit import DedicatedInstance

db = DedicatedInstance(
    host=os.environ.get("HOST"),
    port=os.environ.get("PORT"),
    user=os.environ.get("USERNAME"),
    password=os.environ.get("PASSWORD"),
    database=os.environ.get("DATABASE"),
    sslmode=os.environ.get("SSLMODE"),
    debug=True,
)

...
```

### Documentation
You can view the full documentation for this package [here](docs), or select the module you're interested in below:

| Module | Description                                          | Documentation        |
| ------ | ---------------------------------------------------- | -------------------- |
| Sync   | Utilities for pulling data from a dedicated instance | [View](docs/sync.md) |

### Examples
You can view examples of how to use this package in the [examples](examples) directory.
