https://github.com/anna-geller/kestra-ion

Read and write Amazon Ion files
https://github.com/anna-geller/kestra-ion

Last synced: 16 days ago
JSON representation

Read and write Amazon Ion files

• Host: GitHub
• URL: https://github.com/anna-geller/kestra-ion
• Owner: anna-geller
• License: apache-2.0
• Created: 2024-04-21T14:10:24.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-21T16:30:57.000Z (7 months ago)
• Last Synced: 2024-09-25T22:54:39.433Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kestra-ion

The `kestra-ion` package provides an easy-to-use interface for reading and writing Amazon Ion data files to integrate this data format into Python applications, particularly for analysis with libraries like pandas or polars.

## Features

- **Read Amazon Ion files**: Convert Ion data into Python data structures.

- **Pandas Integration**: Easily convert Ion data into pandas DataFrames for further analysis.

- **Simple API**: A minimalistic and easy-to-understand API.

## Installation

To install `kestra-ion`, you can use pip:

```bash

pip install kestra-ion

```

Ensure that you have Python 3.6 or later installed. This package depends on `amazon.ion` library, which will be installed during the installation process.

## Usage Example

Here's a quick example to get you started with reading Amazon Ion data and converting it into a pandas DataFrame:

```python

from kestra_ion import read_ion

import pandas as pd

import requests

file_path = "employees.ion"

url = "https://huggingface.co/datasets/kestra/datasets/resolve/main/ion/employees.ion"

response = requests.get(url)

if response.status_code == 200:

    with open(file_path, "wb") as file:

        file.write(response.content)

else:

    print(f"Failed to download the file. Status code: {response.status_code}")

data = read_ion(file_path)

df = pd.DataFrame(data)

print(df.info())

```

This example reads data from an Ion file, converts it into a list of dictionaries, and then creates a pandas DataFrame from this list. The output includes details about the types of columns and general information about the DataFrame.

## Contributing

Contributions to `kestra-ion` are welcome! Here are a few ways you can help:

- Report bugs and issues.

- Suggest new features or enhancements.

- Improve documentation.

- Submit pull requests to address known issues.

## License

`kestra-ion` is distributed under Apache 2.0. See the LICENSE file in the GitHub repository for more details.

## Contact

If you have specific questions about the `kestra-ion` package, feel free to reach out via GitHub issues.