Metadata-Version: 2.1
Name: palourde
Version: 1.0.4
Summary: Converts v2.1 Postman Collections into Markdown Files
Project-URL: Homepage, https://github.com/bagabool/palourde
Author-email: Victor Martin <vicmartindev@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: dacite>=1.7.0
Requires-Dist: python-slugify>=7.0.0
Description-Content-Type: text/markdown

## Palourde

![version](https://img.shields.io/badge/version-1.0.3-blue) ![python](https://img.shields.io/badge/python-%3E=3.10-brightgreen) ![postman](https://img.shields.io/badge/postman%20collection-2.1-yellowgreen) 

Palourde converts **a v2.1 Postman collection**,  into a **markdown file**, shareable on Github or in Obsidian.

[How to export your postman collection](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/#exporting-collections)

Be aware, palourde will explore recursively all your folders and subfolders to get to the requests, so **the end result won't display your folder structure**.

Palourde **won't display** your private tokens and api  keys either.

Note that palourde has only been tested on version **2.1** postman collections and on Python **3.10**.


<br>

### Installation
---

```shell
pip install palourde
```

<br>

### Usage
---

```shell
palourde demo.postman_collection.json
```

This should generate a `demo.md` file in the same folder.

See [Demos](https://github.com/bagabool/palourde/tree/main/demo).