Skip to content

Commit

Permalink
chore: updating pyproject and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nephi-dev authored Dec 15, 2023
1 parent 1c427aa commit d871820
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@ We write the following python code:
```python
from rxml import read_file

root_file = read_file("test.xml", "note")
root_node = read_file("test.xml", "note")
```

where `"test.xml"` is the `file_name` and `"note"` is the `root_tag`.

After that we can simply iter through the children with:

```python
for node in root_file.children:
# do something whith the node here
for node in root_node.children:
# do something with the node here
```

You can also write it to a file or string(refer to the `.pyi` file for the args).
Expand Down
14 changes: 12 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,23 @@ build-backend = "maturin"

[project]
name = "rxml"
requires-python = ">=3.12"
description = "RXML is a python library to read and write xml files up to 2 times faster than python's xml included library."
readme = "README.md"
requires-python = ">=3.10"
license = "MIT"
authors = [
{ name = "Matheus Mendes", email = "[email protected]" },
]
classifiers = [
"Programming Language :: Rust",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Typing :: Typed",
"License :: OSI Approved :: MIT License",
]
description = "A XML parser for Python written in Rust"


[tool.maturin]
Expand Down

0 comments on commit d871820

Please sign in to comment.