Metadata-Version: 2.4
Name: pslmw-md-workers
Version: 1.0.0
Summary: pslmw-md-workers is a python tool for creating a `TOC` content from the .md file inside of it, using CLI.
Author-email: Emili Garriga Coll <porsilasmocasweb@gmail.com>
Maintainer-email: Emili Garriga Coll <porsilasmocasweb@gmail.com>
License: The MIT License (MIT)
        
        Copyright (c) 2025 Emili Garriga Coll
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/porsilasmoscasweb/pslmw-md-workers
Project-URL: Bug Tracker, https://github.com/porsilasmoscasweb/pslmw-md-workerss
Keywords: markdown,sort,organization,TOC,md,index,files
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pslmw-md-toc
Requires-Dist: pslmw-md-toc-files
Requires-Dist: pslmw-md-toc-files-plus
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

# pslmw-md-workers

**pslmw-md-workers** is a python tool for creating a Table of Contents `TOC` from a directory with a simple execution.

## Installation

To install and use **md-worker**, follow these steps:

1. **Clone the repository**:

```bash
git clone https://github.com/porsilasmoscasweb/pslmw-md-workers.git
```

2. **Go to the project folder**:

```bash
cd md-worker
```
3. **Use the helper to now better what args do you will use:**

```bash
python3 main.py -h 
```

```text
# Output

usage: main.py [-h] [-t] [-i [IGNORE ...]] [-otf OUTPUT_TOC_FILENAME] [-o [OUTPUT_DIR ...]] root_dir

Generate TOC for Markdown files.

positional arguments:
  root_dir              Root path

options:
  -h, --help            show this help message and exit
  -t, --toc             To generate TOC.
  -i [IGNORE ...], --ignore [IGNORE ...]
                        List of directories (without absolute path) to ignore (separated by spaces).
  -otf OUTPUT_TOC_FILENAME, --output_toc_filename OUTPUT_TOC_FILENAME
                        Name of the output file (No extension). By default: 'TOC'
  -o [OUTPUT_DIR ...], --output_dir [OUTPUT_DIR ...]
                        Generates a copy of all files to an specified destination path or the default path '_output' and works on this directory.
```

4. **The output from the command will be:**

```bash
python3 main.py [-t | --toc]
```

## TESTING

You can run tests to see if everything it is working properly.

To do it, follow these steps:

1. **Install dependencies:**

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

2. **Use `pytest` to run the _test_**

```bash
pytest  test/test_args.py [-v -vv]
```
