semvec/pypi-packages huggingface dataset:
mkdocs-ansible-collection 1.1.0
MkDocs Plugin that automatically generates pages for Ansible Collections.
License: MIT
Requires Python: >=3.9
Keywords: mkdocs, ansible

# MkDocs Ansible Collection

[MkDocs](https://www.mkdocs.org) Plugin that automatically generates documentation pages for Ansible Collections. Check out the showcase over on the project's [documentation page](https://mkdocs-ansible-collection.readthedocs.io/en/stable/showcase/) and more detailed [User](https://mkdocs-ansible-collection.readthedocs.io/en/stable/user/) and [Developer](https://mkdocs-ansible-collection.readthedocs.io/en/stable/dev/) guides!

## Quick Start

1. Add the `mkdocs-ansible-collection` Python package to your project's docs dependencies. It will also install `ansible-core` to manage collections and get the required metadata.

    ```
    pip install mkdocs-ansible-collection
    ```

2. Install any needed collection(s) using `ansible-galaxy collection install example.collection` or point ansible at the correct collection path.

3. Enable the plugin in your project's `mkdocs.yaml` file:

    ```yaml
    plugins:
      - "ansible-collection":
          collections:
            - fqcn: "example.collection"
    ```

4. Add an anchor page to the `nav` section of your project's `mkdocs.yaml` file:

    ```yaml
    nav:
      # The anchor is named after the Collection FQCN and it tells mkdocs where
      # to generate the documentation tree. The following examples show all of
      # the currently supported combinations:
      - "Example Collection": "example.collection" # With an explicit page name
      - "Nested Under Another Page":
        - "example.collection" # Without a custom page name
    ```

For more details, check out the [User Guide](https://mkdocs-ansible-collection.readthedocs.io/en/stable/user/) and look at the live example of [this project's docs](https://github.com/cmsirbu/mkdocs-ansible-collection), which showcase how to build and host collection docs on the awesome [Read the Docs](https://about.readthedocs.com/) service!

## Contributions

Contributions of all sorts (bug reports, features, documentation etc.) are welcome! Any larger change, please open a new [issue](https://github.com/cmsirbu/mkdocs-ansible-collection/issues) to discuss it first.
fsblueprint 0.3.1
Bidirectional YAML ↔ Directory Structure Tool
License: MIT
Requires Python: >=3.8
Keywords: directory, filesystem, scaffold, structure, yaml

# FSBlueprint

**FSBlueprint** is a Python CLI and API tool for working with directory structures and blueprints. Easily scaffold projects from YAML definitions or generate reusable blueprints from existing directories.

---

## ✨ Features

- ✅ Scaffold full folder structures from a simple YAML blueprint
- ✅ Generate YAML from any existing folder structure
- ✅ Default: Outputs a **tree-style structure preview**
- ✅ Optional: Include **file contents** in the YAML blueprint with `--with-content`
- ✅ Supports nested folders, empty files, and multiline content
- ✅ Simple CLI + importable Python API

---

## 📦 Installation

Install from PyPI:

```bash
pip install fsblueprint
```

---

## 🚀 Usage

### 🔧 Scaffold a directory structure from YAML

```bash
fsblueprint scaffold project.yaml ./my_project
```

This creates folders and files based on your `project.yaml` blueprint.

---

### 🔍 Preview a directory structure

```bash
fsblueprint blueprint ./existing_project
```

This will print a tree-like structure of your folder (ignoring system/development files by default).

#### Example output:

```
📂 Structure Preview:

existing_project/
├── README.md
├── src/
│   ├── main.py
│   └── utils/
│       └── helper.py
└── tests/
    └── test_main.py
```

---

### 🧾 Generate YAML with file contents

```bash
fsblueprint blueprint ./existing_project blueprint.yaml --with-content
```

This saves a `.yaml` file that includes both structure and file content.

---

## 📄 Example YAML Blueprint

```yaml
my_project:
  README.md: |
    # My Project
    Hello world!
  src:
    main.py: |
      def main():
          print("Hello!")
    utils:
      helper.py: ""
  tests:
    test_main.py: ""
```

---

## 🛠 Ignore Patterns

By default, FSBlueprint excludes common directories like `.git`, `node_modules`, `.env`, `__pycache__`, etc.
Use `--no-ignore` to include everything, or `--ignore pattern1 pattern2` to extend ignore behavior.

---

## 📜 License

MIT