Metadata-Version: 2.4
Name: capture-pkg
Version: 0.1.0
Summary: A modular capture package for integration with x-ray application and PyPI distribution.
Author-email: wisnubaldas <wisnubaldas@gmail.com>
License-Expression: MIT
Keywords: capture,x-ray,hyfetch,imaging
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: hyfetch>=1.4.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"

# capture-pkg

Python package for capture functionality integrated with `hyfetch` and `x-ray` system.

## 🚀 Installation & Usage Guide

### 1. Installation from PyPI

Once published to PyPI, install directly using `pip`:

```bash
pip install capture-pkg
```

---

### 2. Local Development Setup

To work on this package locally in editable mode:

```bash
# Clone repository or navigate to directory
cd capture_pkg

# Install in editable mode with development dependencies
pip install -e .[dev]
```

---

### 3. Building Package for PyPI

Before uploading to PyPI, build the distribution archives (`.whl` and `.tar.gz`):

```bash
# Install build tools if not available
pip install build twine

# Build distribution packages
python -m build
```

---

### 4. Uploading to PyPI

Upload the generated build artifacts from the `dist/` directory to PyPI using `twine`:

```bash
# Test upload (optional, using TestPyPI)
python -m twine upload --repository testpypi dist/*

# Production upload to PyPI
python -m twine upload dist/*
```

---

### 5. Integration with `x-ray` Application

To integrate `capture-pkg` into the `x-ray` application:

1. Add `capture-pkg` to `x-ray/requirements.txt`:
   ```text
   capture-pkg>=0.1.0
   ```

2. Install dependencies in your `x-ray` environment:
   ```bash
   pip install -r requirements.txt
   ```

---

## ✨ Features

- **HyFetch Integration**: Custom fetch output and terminal branding.
- **X-Ray Compatible**: Designed specifically for capture workflows in the `x-ray` application backend.

