Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clouder0/siyuanhelper
The Helper Lib for Siyuan Note.
https://github.com/clouder0/siyuanhelper
python siyuan siyuan-note
Last synced: 17 days ago
JSON representation
The Helper Lib for Siyuan Note.
- Host: GitHub
- URL: https://github.com/clouder0/siyuanhelper
- Owner: Clouder0
- License: mit
- Created: 2021-11-12T09:23:52.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T21:26:01.000Z (22 days ago)
- Last Synced: 2024-10-22T16:56:28.562Z (21 days ago)
- Topics: python, siyuan, siyuan-note
- Language: Python
- Homepage: https://clouder0.github.io/siyuanhelper
- Size: 567 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
siyuanhelper
The Helper Lib for Siyuan Note.
Explore the docs Β»
δΈζ Β»
## π TOC
Table of Contents
- [π Badges](#π-badges)
- [π‘ Introduction](#π‘-introduction)
- [β¨ Features](#β¨-features)
- [π Getting Started](#π-getting-started)
- [πΊοΈ Roadmap](#πΊοΈ-roadmap)
- [β Faq](#β-faq)
- [π Contributing](#π-contributing)
- [π Acknowledgment](#π-acknowledgment)
- [π License](#π-license)
- [π§ Contact](#π§-contact)
## π 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
Siyuan Helper is a python API wrapper for [Siyuan Note](https://github.com/siyuan-note/siyuan).
## β¨ Features
- Aysnc
- Object Oriented
- Type Annotated
- Fully Documented
## π Getting Started
See our [Quickstart](https://clouder0.github.io/siyuanhelper/quickstart/) to get hands on experience.
## πΊοΈ 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).
## β FAQ
## π 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.
## π 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
## π License
Distributed under the MIT License. See `LICENSE` for more information.
## π§ Contact
Clouder0's email: [email protected]
Project Link: [https://github.com/Clouder0/siyuanhelper](https://github.com/Clouder0/siyuanhelper)
[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