Metadata-Version: 2.4
Name: spezialist
Version: 1.0.0
Summary: A special list tool
Author-email: Felix Wuehler <f.wuehler@hs-mannheim.de>
Project-URL: Homepage, https://github.com/BlueSpacePotato/speciallist
Project-URL: Issues, https://github.com/BlueSpacePotato/speciallist/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Provides-Extra: build
Requires-Dist: twine; extra == "build"
Requires-Dist: build; extra == "build"
Dynamic: license-file

![PyPI Version](https://img.shields.io/pypi/v/spezialist)
![License](https://img.shields.io/pypi/l/spezialist)
[![codecov](https://codecov.io/gh/BlueSpacePotato/spezialist/graph/badge.svg?token=MJJGOIWYUG)](https://codecov.io/gh/BlueSpacePotato/spezialist)


# spezialist

A lightweight Python utility for **special listing methods**. `spezialist` provides simple functions to filter directory listings, exclude unwanted or hidden files, and streamline specialized list processing tasks.

---

## Features

* 📁 **Clean Directory Listings**: Exclude system files like `.DS_Store` or hidden entries.
* 🌐 **Absolute or Relative Paths**: Choose to return full filesystem paths or just filenames.
* 🐍 **Pure Python, Zero Dependencies**: Only uses the standard library (`os` module).
* 🧩 **Modular Functions**: Import only what you need.

---

## Installation

Install via pip:

```bash
pip install spezialist
```

---

## Quickstart

```python
from spezialist import (
    list_dir_without_ds,         # filenames, no .DS_Store
    list_dir_without_ds_abs,     # absolute paths, no .DS_Store
    list_dir_without_dot,        # filenames, no hidden files
    list_dir_without_dot_abs,    # absolute paths, no hidden files
)

# List only visible filenames
files = list_dir_without_dot("./my_folder")
print(files)

# List absolute paths excluding .DS_Store
paths = list_dir_without_ds_abs("./Downloads")
print(paths)
```

---

## Contributing

Contributions are welcome! Please:

1. Fork the repo on GitHub
2. Create a feature branch (`git checkout -b feature/YourFeature`)
3. Write tests and update documentation
4. Submit a pull request

Ensure all tests pass:

```bash
pytest
```

---

## License

This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
