Metadata-Version: 2.1
Name: SDRenderer
Version: 0.0.1
Summary: A small python package
Home-page: https://github.com/shk0224/SD-Renderer-PyPi-Package
Author: shk0224
Author-email: shuvo.du333@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/shk0224/SD-Renderer-PyPi-Package/issues
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
License-File: LICENSE
Requires-Dist: ensure==1.0.2
Requires-Dist: py-youtube==1.1.7
Provides-Extra: testing
Requires-Dist: pytest>=7.1.3; extra == "testing"
Requires-Dist: mypy>=0.971; extra == "testing"
Requires-Dist: flake8>=5.0.4; extra == "testing"
Requires-Dist: tox>=3.25.1; extra == "testing"

# SD Renderer (PyPI Package)

A Python package for rendering structured content (Markdown / Docs / Code) into clean output formats.

---

## 🚀 Setup Instructions

### Step 1: Create Virtual Environment

```bash
conda create -n renderer python=3.8 -y
conda activate renderer
```

---

### Step 2: Create Project Structure

Project Name: **SDRenderer**

Create the standard folder structure using your template.

Example:

```
SDRenderer/
│── src/
│── tests/
│── setup.py
│── setup.cfg
│── pyproject.toml
│── requirements_dev.txt
```

---

### Step 3: Install Development Dependencies

```bash
pip install -r requirements_dev.txt
```

---

### Step 4: Configure Packaging Files

Make sure the following files are properly implemented:

- setup.py  
- setup.cfg  
- pyproject.toml  

These files define how your package is built and distributed.

---

## 📦 Build & Install Package (Optional)

```bash
pip install .
```

---

## 🧪 Run Tests (Optional)

```bash
pytest
```

---

## 📌 Notes

- Always activate the virtual environment before working  
- Keep dependencies updated in requirements_dev.txt  
- Follow proper versioning before publishing to PyPI  

---

## 👨‍💻 Author

Shuvo Dutta
