siyuanhelper 0.3.0
Helper lib for Siyuan Note
License: MIT
Requires Python: >=3.8,<4.0

<div id="top"></div>

<h3 align="center">siyuanhelper</h3>
  <p align="center">
    The Helper Lib for Siyuan Note.
    <br />
    <a href="https://clouder0.github.io/siyuanhelper/"><strong>Explore the docs »</strong></a>
    <br />
    <a href="https://github.com/Clouder0/siyuanhelper/blob/main/README.zh-Hans.md"><strong>中文 »</strong></a>
  </p>
</div>

## 📜 TOC

<details><summary>Table of Contents</summary>

- [🌟 Badges](#🌟-badges)
- [💡 Introduction](#💡-introduction)
- [✨ Features](#✨-features)
- [🎏 Getting Started](#🎏-getting-started)
- [🗺️ Roadmap](#🗺️-roadmap)
- [❓ Faq](#❓-faq)
- [💌 Contributing](#💌-contributing)
- [🙏 Acknowledgment](#🙏-acknowledgment)
- [📖 License](#📖-license)
- [📧 Contact](#📧-contact)

</details>

## 🌟 Badges

[![Test][github-action-test-shield]][github-action-test-url]
[![Codecov][codecov-shield]][codecov-url]
[![pre-commit-ci][pre-commit-ci-shield]][pre-commit-ci-url]
[![pepy-shield]][pepy-url]

[![release-shield]][release-url]
[![pyversions-shield]][pyversions-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![CodeFactor-shield]][CodeFactor-url]
[![code-style-black-shield]][code-style-black-url]

<!-- INTRODUCTION -->
## 💡 Introduction

Siyuan Helper is a python API wrapper for [Siyuan Note](https://github.com/siyuan-note/siyuan).

<p align="right">(<a href="#top">back to top</a>)</p>

## ✨ Features

- Aysnc
- Object Oriented
- Type Annotated
- Fully Documented

<p align="right">(<a href="#top">back to top</a>)</p>

## 🎏 Getting Started

See our [Quickstart](https://clouder0.github.io/siyuanhelper/quickstart/) to get hands on experience.

<p align="right">(<a href="#top">back to top</a>)</p>

## 🗺️ Roadmap

Please check out our [Github Project](https://github.com/Clouder0/siyuanhelper/projects/1).

See the [open issues](https://github.com/Clouder0/siyuanhelper/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p>

## ❓ FAQ

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- CONTRIBUTING -->
## 💌 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

Don't forget to see our [Contributing Guidelines](https://github.com/Clouder0/siyuanhelper/blob/main/CONTRIBUTING.md) for details.

<p align="right">(<a href="#top">back to top</a>)</p>

## 🙏 Acknowledgment

There are various open source projects that siyuanhelper depends on, without which this tool wouldn't exist. Credits to them!

- [aiohttp](https://github.com/aio-libs/aiohttp), Apache License 2.0

<p align="right">(<a href="#top">back to top</a>)</p>

## 📖 License

Distributed under the MIT License. See `LICENSE` for more information.

<p align="right">(<a href="#top">back to top</a>)</p>

## 📧 Contact

Clouder0's email: clouder0@outlook.com

Project Link: [https://github.com/Clouder0/siyuanhelper](https://github.com/Clouder0/siyuanhelper)

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/Clouder0/siyuanhelper.svg?style=for-the-badge
[contributors-url]: https://github.com/Clouder0/siyuanhelper/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Clouder0/siyuanhelper.svg?style=for-the-badge
[forks-url]: https://github.com/Clouder0/siyuanhelper/network/members
[stars-shield]: https://img.shields.io/github/stars/Clouder0/siyuanhelper.svg?style=for-the-badge
[stars-url]: https://github.com/Clouder0/siyuanhelper/stargazers
[issues-shield]: https://img.shields.io/github/issues/Clouder0/siyuanhelper.svg?style=for-the-badge
[issues-url]: https://github.com/Clouder0/siyuanhelper/issues
[license-shield]: https://img.shields.io/github/license/Clouder0/siyuanhelper.svg?style=for-the-badge
[license-url]: https://github.com/Clouder0/siyuanhelper/blob/main/LICENSE
[github-action-test-shield]: https://github.com/Clouder0/siyuanhelper/actions/workflows/test.yml/badge.svg?branch=main
[github-action-test-url]: https://github.com/Clouder0/siyuanhelper/actions/workflows/test.yml
[codecov-shield]:https://codecov.io/gh/Clouder0/siyuanhelper/branch/main/graph/badge.svg?token=D2XT099AFB
[codecov-url]: https://codecov.io/gh/Clouder0/siyuanhelper
[pre-commit-ci-shield]: https://results.pre-commit.ci/badge/github/Clouder0/siyuanhelper/main.svg
[pre-commit-ci-url]: https://results.pre-commit.ci/latest/github/Clouder0/siyuanhelper/main
[code-style-black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge
[code-style-black-url]: https://github.com/psf/black
[pyversions-shield]: https://img.shields.io/pypi/pyversions/siyuanhelper.svg?style=for-the-badge
[pyversions-url]: https://pypi.org/project/siyuanhelper/
[release-shield]: https://img.shields.io/github/release/Clouder0/siyuanhelper.svg?style=for-the-badge
[release-url]: https://github.com/Clouder0/siyuanhelper/releases
[CodeFactor-shield]: https://www.codefactor.io/repository/github/clouder0/siyuanhelper/badge/main?style=for-the-badge
[CodeFactor-url]: https://www.codefactor.io/repository/github/clouder0/siyuanhelper/overview/main
[pepy-shield]: https://static.pepy.tech/personalized-badge/siyuanhelper?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads
[pepy-url]: https://pepy.tech/project/siyuanhelper