Metadata-Version: 2.4
Name: octodns-mikrotik
Version: 0.1.1
Summary: Mikrotik provider for octoDNS
Keywords: dns,mikrotik,octodns
Author: Ludovic Ortega
Author-email: Ludovic Ortega <ludovic.ortega@adminafk.fr>
License-Expression: CECILL-2.1
License-File: LICENSE.txt
License-File: LICENSE_en.txt
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Utilities
Requires-Dist: octodns>=1.10.0,<2.0.0
Requires-Dist: requests>=2.32.0
Requires-Python: >=3.10, <4.0.0
Project-URL: Funding, https://ko-fi.com/ludovicortega
Project-URL: Homepage, https://github.com/M0NsTeRRR/octodns-mikrotik
Project-URL: Issues, https://github.com/M0NsTeRRR/octodns-mikrotik/issues
Project-URL: Repository, https://github.com/M0NsTeRRR/octodns-mikrotik
Description-Content-Type: text/markdown

<!-- do not edit anything in "template" block, its auto-generated by Pulumi -->
<!-- template:begin:header -->
<div align="center">
<img src="https://raw.githubusercontent.com/m0nsterrr/octodns-mikrotik/main/docs/assets/logo.svg" align="center" width="144px" height="144px"/>

### octodns-mikrotik

_MikroTik provider for octoDNS_

</div>

<div align="center">

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

<div align="center">

[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/M0NsTeRRR/octodns-mikrotik?label=openssf%20scorecard&style=for-the-badge)](https://scorecard.dev/viewer/?uri=github.com/M0NsTeRRR/octodns-mikrotik)

</div>
<!-- template:end:header -->

<!-- template:begin:table_of_content -->
## 🔗 Table of Contents
- [Usage](#-usage)
    - [Pypi](#-pypi)
- [Configuration](#-configuration)
- [Dev](#%EF%B8%8F-dev)
    - [Run linter and formatter](#run-linter-and-formatter)
    - [Run test](#run-test)
- [Support &amp; Assistance](#-support--assistance)
- [Contributing](#-contributing)
- [Security](#-security)
- [License](#-license)
<!-- template:end:table_of_content -->

<!-- template:begin:usage/title -->
## 🪐 Usage
<!-- template:end:usage/title -->

<!-- template:begin:usage/pypi -->
#### 🐍 Pypi
Install the package `pip install octodns-mikrotik`.
<!-- template:end:usage/pypi -->

<!-- template:begin:configuration -->
## 📜 Configuration
<!-- template:end:configuration -->
```yaml
providers:
  mikrotik:
    class: octodns_mikrotik.MikroTikProvider
    host: router.example.com
    port: 443
    user: env/MIKROTIK_USER
    password: env/MIKROTIK_PASSWORD
    scheme: https
    ssl_verify: true
```
<!-- template:begin:dev -->
## 🛠️ Dev

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

Install python and setup dependencies with `uv sync --all-extras`.
### Run linter and formatter

```
uv run ruff format .
uv run ruff check .
```

### Run test

```
uv run pytest --cov
```
### Devcontainer

A dev container is available; the documentation can be found on how to use it [here](https://code.visualstudio.com/docs/devcontainers/containers).
<!-- template:end:dev -->

<!-- template:begin:support -->
## 🙋‍♂️ Support & Assistance

- Take a look at the [support](SUPPORT.md) document on
     guidelines for tips on how to ask the right questions.
- For all questions/features/bugs/issues [head over here](/../../issues/new/choose).
<!-- template:end:support -->

<!-- template:begin:contributing -->
## 🤝 Contributing

- Please review the [Code of Conduct](CODE_OF_CONDUCT.md) for guidelines
    on ensuring everyone has the best experience interacting with the community.
- We welcome and encourage contributions to this project !
    Please review the [contributing](CONTRIBUTING.md) doc for submitting
    issues/a guide on submitting pull requests and helping out.
<!-- template:end:contributing -->

<!-- template:begin:security -->
## 🛡️ Security

See [security](SECURITY.md) file for details.
<!-- template:end:security -->

<!-- template:begin:license -->
## ⚖️ License

See [here](LICENSE_en.txt).
<!-- template:end:license -->
