Metadata-Version: 2.4
Name: ds-resource-plugin-py-lib
Version: 0.1.0a2
Summary: A Python package from the ds-common library collection
Author-email: Kristoffer Varslott <hello@grasplabs.com>
Maintainer-email: Kristoffer Varslott <hello@grasplabs.com>
License-Expression: Apache-2.0
Project-URL: Documentation, https://grasp-labs.github.io/ds-resource-plugin-py-lib/
Project-URL: Repository, https://github.com/grasp-labs/ds-resource-plugin-py-lib/
Project-URL: Issues, https://github.com/grasp-labs/ds-resource-plugin-py-lib/issues/
Project-URL: Changelog, https://github.com/grasp-labs/ds-resource-plugin-py-lib/releases
Keywords: ds,common,python
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE-APACHE
Requires-Dist: pandas<3.0.0,>=2.1.0
Requires-Dist: awswrangler<4.0.0,>=3.11.0
Requires-Dist: pyyaml<7.0.0,>=6.0.2
Requires-Dist: typing-extensions<5.0.0,>=4.0.0
Requires-Dist: ds-common-logger-py-lib<1.0.0,>=0.1.0a1
Requires-Dist: ds-common-serde-py-lib<1.0.0,>=0.1.0a2
Provides-Extra: dev
Requires-Dist: ruff>=0.1.8; extra == "dev"
Requires-Dist: mypy>=1.7.0; extra == "dev"
Requires-Dist: pandas-stubs>=2.1.0; extra == "dev"
Requires-Dist: types-PyYAML>=6.0.0; extra == "dev"
Requires-Dist: pytest>=7.4.0; extra == "dev"
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
Requires-Dist: pytest-xdist>=3.3.0; extra == "dev"
Requires-Dist: pre-commit>=3.6.0; extra == "dev"
Requires-Dist: build>=1.0.0; extra == "dev"
Requires-Dist: twine>=4.0.0; extra == "dev"
Requires-Dist: sphinx>=7.1.0; extra == "dev"
Requires-Dist: sphinx-autoapi>=3.0.0; extra == "dev"
Requires-Dist: sphinx-material>=0.0.35; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=7.4.0; extra == "test"
Requires-Dist: pytest-cov>=4.1.0; extra == "test"
Requires-Dist: pytest-xdist>=3.3.0; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx>=7.1.0; extra == "docs"
Requires-Dist: sphinx-autoapi>=3.0.0; extra == "docs"
Requires-Dist: sphinx-material>=0.0.35; extra == "docs"
Dynamic: license-file

# ds-resource-plugin-py-lib

A Python package from the ds-common library collection.

## Installation

Install the package using pip:

```bash
pip install ds-resource-plugin-py-lib
```

Or using uv (recommended):

```bash
uv pip install ds-resource-plugin-py-lib
```

## Quick Start

```python
from ds_resource_plugin_py_lib import __version__

print(f"ds-resource-plugin-py-lib version: {__version__}")
```

## Usage

```python
# Example usage
from ds_resource_plugin_py_lib.common.resource import ResourceClient

resource_client = ResourceClient()
linked_service = resource_client.linked_service(config=config)
dataset = resource_client.dataset(config=config)

linked_service.connect()

dataset.create()
dataset.read()
dataset.delete()
dataset.update()
dataset.rename()
```

## Requirements

- Python 3.11 or higher

## Documentation

Full documentation is available at:

- [GitHub Repository](https://github.com/grasp-labs/ds-resource-plugin-py-lib)
- [Documentation Site](https://grasp-labs.github.io/ds-resource-plugin-py-lib/)

## Development

To contribute or set up a development environment:

```bash
# Clone the repository
git clone https://github.com/grasp-labs/ds-resource-plugin-py-lib.git
cd ds-resource-plugin-py-lib

# Install development dependencies
uv sync --all-extras --dev

# Run tests
make test
```

See the
[README](https://github.com/grasp-labs/ds-resource-plugin-py-lib#readme)
for more information.

## License

This package is licensed under the Apache License 2.0. See the
[LICENSE-APACHE](https://github.com/grasp-labs/ds-resource-plugin-py-lib/blob/main/LICENSE-APACHE)
file for details.

## Support

- **Issues**: [GitHub Issues](https://github.com/grasp-labs/ds-resource-plugin-py-lib/issues)
- **Releases**: [GitHub Releases](https://github.com/grasp-labs/ds-resource-plugin-py-lib/releases)
