semvec/pypi-packages huggingface dataset:
mkdocs-d2-plugin 1.6.0
MkDocs plugin for D2
License: MIT
Requires Python: >=3.9
Keywords: mkdocs python markdown d2 diagram

# mkdocs-d2-plugin

A plugin for embedding D2 diagrams in MkDocs.

**Documentation and live demo can be found
[here](https://landmaj.github.io/mkdocs-d2-plugin/).**

## Requirements

* [Python](https://www.python.org/) >= 3.9
* [MkDocs](https://www.mkdocs.org/) >= 1.6.0
* [D2](https://d2lang.com) >= 0.6.3

## Installation

Install the plugin using pip:

```bash
pip install mkdocs-d2-plugin
```

And add it to your `mkdocs.yml`:

```yaml
plugins:
  - d2
```

## Usage

### Fenced code block

````md
```d2
shape: sequence_diagram
Alice -> John: Hello John, how are you?
Alice -> John.ack: John, can you hear me?
John.ack -> Alice: Hi Alice, I can hear you!
John -> Alice: I feel great!
```
````

### Image tag

```md
![Diagram](diagram.d2)
```

## Demo app

You can find demo app in the `docs` directory.
Live version is available [here](https://landmaj.github.io/mkdocs-d2-plugin/).

To run in locally:

```bash
cd docs
python3 -m venv .venv
source .venv/bin/activate
pip install mkdocs-material mkdocs-d2-plugin
mkdocs serve
```

To run it using Docker:

```bash
cd docs
docker build --tag mkdocs-d2-plugin:latest .
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-d2-plugin:latest
```
catface 0.1.5
CLI tool to setup Python projects
License: MIT
Requires Python: >=3.11

<h1 align="center">
  <img src="https://raw.githubusercontent.com/YanickJair/catface/main/static/catface-logo.png" alt="catface" width="200px">
  <br>
</h1>

<p align="center">
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-_red.svg"></a>
</p>

`catface` s a Command Line Interface (CLI) tool that helps you create Python projects with best practices built-in. It uses [cookiecutter](https://www.cookiecutter.io/) under the hood to provide project templates that you can customize based on your needs.


## Features

- **Documentation (MkDocs)**
  - Automatic API documentation
  - Material design theme
  - Ready-to-deploy structure

- **Docker Integration**
  - Multi-stage builds
  - Production-ready configuration
  - Python version specific base images

- **Development Tools**
  - Pre-commit hooks for code quality
  - Ruff for fast linting and formatting
  - Tox for testing across Python versions

## Quick Start

```bash
# Install Catface
pip install catface

# Create a new project
catface my-awesome-project
```

<h1 align="center">
  <img src="https://raw.githubusercontent.com/YanickJair/catface/main/static/features-prompt.png" alt="catface" width="700px">
  <br>
</h1>

<h1 align="center">
  <img src="https://raw.githubusercontent.com/YanickJair/catface/main/static/python-version.png" alt="catface" width="700px">
  <br>
</h1>


## Project structure
The final project structure is going to be something like this based on the features you choose.
<h1 align="center">
  <img src="https://raw.githubusercontent.com/YanickJair/catface/main/static/done.png" alt="catface" width="700px">
  <br>
</h1>


## Pre-configured Tox file
  - Task automation: Using Tox we can automate repetitive tasks
  - Test against multiple Python versions
  - Environment management: Using Tox we can create different environments each with its dependencies
  - Lint and format code using Ruff

```bash
# Cd inside your project
cd my-awesome-project

tox # runs all environments
tox -e <env_name> # running each environment individually by name
tox -p all # parallel execution