Skip to content

Commit

Permalink
chore(pulumi): auto-applied readme
Browse files Browse the repository at this point in the history
this file was auto-applied from pulumi
located here:
    - https://github.com/octodns-infomaniak/.github

Signed-off-by: Ludovic Ortega <[email protected]>
  • Loading branch information
M0NsTeRRR committed Nov 15, 2024
1 parent 917455b commit d8cc3dc
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,16 @@ _Infomaniak provider for octoDNS_
<div align="center">


[![Lint](https://img.shields.io/github/actions/workflow/status/m0nsterrr/octodns-infomaniak/lint.yml?branch=main&label=&logo=ruff&style=for-the-badge&logoColor=D7FF64&color=black)](https://github.com/m0nsterrr/octodns-infomaniak/tree/main/.github/workflows/lint.yml)
[![Test](https://img.shields.io/github/actions/workflow/status/m0nsterrr/octodns-infomaniak/test.yml?branch=main&label=&logo=pytest&style=for-the-badge&logoColor=white&color=0A9EDC)](https://github.com/m0nsterrr/octodns-infomaniak/tree/main/.github/workflows/test.yml)
[![Release](https://img.shields.io/github/actions/workflow/status/m0nsterrr/octodns-infomaniak/release.yml?branch=main&label=&logo=github&style=for-the-badge&logoColor=black&color=white)](https://github.com/m0nsterrr/octodns-infomaniak/tree/main/.github/workflows/release.yml)
</div>

<div align="center">


[![Pypi](https://img.shields.io/pypi/v/octodns-infomaniak?label=&logo=pypi&style=for-the-badge&logoColor=yellow&color=3776AB)](https://pypi.python.org/pypi/octodns-infomaniak)
[![Python](https://img.shields.io/pypi/pyversions/octodns-infomaniak?label=&logo=python&style=for-the-badge&logoColor=yellow&color=3776AB)](https://pypi.python.org/pypi/octodns-infomaniak)

</div>

Expand All @@ -33,6 +37,9 @@ _Infomaniak provider for octoDNS_

## 🪐 Usage

### Classic
Install the package `pip install octodns-infomaniak` and run it with `python3 -m octodns-infomaniak`




Expand All @@ -42,6 +49,22 @@ _Infomaniak provider for octoDNS_
[Documentation](https://code.visualstudio.com/docs/devcontainers/containers)


### Classic
Install [uv](https://docs.astral.sh/uv/getting-started/installation/).

Install python and setup dependencies with `uv sync`.

### Run unit test
```
uv run pytest --cov
```

### Run ruff
```
uv run ruff format .
uv run ruff check .
```



## 🙋‍♂️ Support & Assistance
Expand Down

0 comments on commit d8cc3dc

Please sign in to comment.