Metadata-Version: 2.4
Name: unfolder
Version: 0.1.1
Summary: A downloadable collection of 19 text files.
Author: Unfolder Contributors
License: MIT
Keywords: text-files,file-collection,downloader,resources
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
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 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Unfolder

A downloadable collection of 19 text files.

## Installation

```bash
pip install unfolder
```

## Download the complete folder

```bash
python -m unfolder download
```

This creates an `unfolder` directory in the current working directory and extracts all 19 `.txt` files into it.

## Download to a specific location

```bash
unfolder download --destination "C:/Users/YourName/Desktop/my-text-files"
```

The destination is the exact folder where the text files will be placed. It is created automatically if it does not exist.

You can also use the module form on systems where the command-line script is not on `PATH`:

```bash
python -m unfolder download --destination "./my-text-files"
```

## Python import

```python
import unfolder

folder = unfolder.download()
print(f"Files are available in: {folder}")
```

Choose a custom destination from Python:

```python
import unfolder

folder = unfolder.download("./my-text-files")
```

Existing files are skipped by default. To replace them:

```python
unfolder.download("./my-text-files", overwrite=True)
```

## Notes

- The collection contains 19 plain-text (`.txt`) files.
- The files are bundled with the package, so no separate download server or internet connection is needed when extracting them.
- Importing `unfolder` does not create or download files. Call `unfolder.download()` when you want to extract the collection.
