siyuanhelper

The Helper Lib for Siyuan Note.
Explore the docs »
中文 »

📜 TOC

Table of Contents

• 🌟 Badges
• 💡 Introduction
• ✨ Features
• 🎏 Getting Started
• 🗺️ Roadmap
• ❓ Faq
• 💌 Contributing
• 🙏 Acknowledgment
• 📖 License
• 📧 Contact

🌟 Badges

💡 Introduction

Siyuan Helper is a python API wrapper for Siyuan Note.

(back to top)

✨ Features

• Aysnc
• Object Oriented
• Type Annotated
• Fully Documented

(back to top)

🎏 Getting Started

See our Quickstart to get hands on experience.

(back to top)

🗺️ Roadmap

Please check out our Github Project.

See the open issues for a full list of proposed features (and known issues).

(back to top)

❓ FAQ

(back to top)

💌 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 for details.

(back to top)

🙏 Acknowledgment

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

• aiohttp, Apache License 2.0

(back to top)

📖 License

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

(back to top)

📧 Contact

Clouder0's email: clouder0@outlook.com

Project Link: https://github.com/Clouder0/siyuanhelper

(back to top)