Holllo/opyml
Holllo
/
opyml
1
Fork 0
Code Releases 3 Activity

Rewrite readme.

This commit is contained in:
Bauke 2022-09-25 23:44:09 +02:00
parent aa0893be96
commit f7de27d334
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,8 +1,12 @@
# opyml # OPyML 🐍
An OPML library for Python. > **OPML library for Python.**
This is a largely identical "port" of [the Rust crate](https://github.com/Holllo/opml). ## Features
* Supports all OPML versions.
* Minimal use of dependencies.
* 100% typed and tested.
## Example ## Example
@ -20,16 +24,18 @@ xml = document.to_xml()
document = OPML.from_xml(xml) document = OPML.from_xml(xml)
``` ```
For complete examples check out the `tests/` directory.
## Development ## Development
* Install dependencies with [Poetry](https://python-poetry.org) (`poetry shell` + `poetry install`). * Install dependencies with `poetry shell && poetry install`.
* Format code with `black opyml tests`. * Format code with `black opyml tests`.
* Check types with `mypy opyml`. * Check types with `mypy opyml`.
* Run tests and collect coverage with `pytest --cov=opyml --cov-report html`. * Run tests and collect coverage with `pytest --cov opyml --cov-report html`.
* Generate documentation with `pdoc opyml`. * Generate documentation with `pdoc opyml`.
## Feedback
Found a problem or want to request a new feature? Email [helllo@holllo.org](mailto:helllo@holllo.org) and I'll see what I can do for you.
## License ## License
Dual-licensed with the [Apache License, Version 2.0](https://github.com/Holllo/opyml/blob/main/LICENSE-Apache) and [MIT license](https://github.com/Holllo/opyml/blob/main/LICENSE-MIT). Distributed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html) and [MIT](https://spdx.org/licenses/MIT.html) licenses, see [LICENSE-Apache](https://git.bauke.xyz/Holllo/opyml/src/branch/main/LICENSE-Apache) and [LICENSE-MIT](https://git.bauke.xyz/Holllo/opyml/src/branch/main/LICENSE-MIT) for more information.