Metadata-Version: 2.4
Name: datashear
Version: 0.1.0
Summary: A Python package that allows you to split CSV files
Project-URL: Homepage, https://github.com/HakumenNC/datashear
Project-URL: Repository, https://github.com/HakumenNC/datashear.git
Project-URL: Bug Tracker, https://github.com/HakumenNC/datashear/issues
Author-email: HakumenNC <soutartronny@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: data,manipulation,split
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
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: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Requires-Dist: psutil>=5.9.0
Provides-Extra: dev
Requires-Dist: black>=22.0.0; extra == 'dev'
Requires-Dist: flake8>=5.0.0; extra == 'dev'
Requires-Dist: isort>=5.10.0; extra == 'dev'
Requires-Dist: mypy>=1.0.0; extra == 'dev'
Requires-Dist: pre-commit>=2.20.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
Requires-Dist: pytest>=7.0.0; extra == 'test'
Description-Content-Type: text/markdown

# DataShear

[![codecov](https://codecov.io/github/HakumenNC/datashear/branch/main/graph/badge.svg?token=0JW393HPAY)](https://codecov.io/github/HakumenNC/datashear)

A Python package that allows you to split CSV files

## Installation

Coming soon! The package is currently in development.

## Usage

Coming soon! The package is currently in development.

## Development

### Setup

1. Clone the repository:
```bash
git clone https://github.com/HakumenNC/datashear.git
cd datashear
```

2. Install in development mode:
```bash
pip install -e ".[dev]"
```

## Testing

> Writing tests means you don’t trust your code.

Running test with [`pytest`](https://docs.pytest.org/en/stable)

```bash
pytest
```

```bash
pytest --cov=src --cov-report=xml
```

### Go further

#### pytest

> The pytest framework makes it easy to write small, readable tests, and can scale to support complex functional testing for applications and libraries.

https://docs.pytest.org/en/stable

- [Method and function level setup/teardown](https://docs.pytest.org/en/stable/how-to/xunit_setup.html#method-and-function-level-setup-teardown)
- [Asserting with the assert statement](https://docs.pytest.org/en/stable/how-to/assert.html)
- [Assertions about expected exceptions](https://docs.pytest.org/en/stable/how-to/assert.html#assertions-about-expected-exceptions)

#### Codecov

> Codecov doesn’t just measure code coverage—it helps you improve code quality at every step.

https://about.codecov.io

- https://github.com/codecov/codecov-action

## Building

Build the package:
```bash
python -m build
```

## License

MIT License - see LICENSE file for details.
