Skip to content

Add usage example in README #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add usage example in README #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,20 @@ could only happen if the player is friendly.
This behaviour is undefined when the log contains a "double-spectate" (both sides
of the games spectated at the same time).

## Usage example

```python
from hslog import LogParser

parser = LogParser()
woth open("path/to/Power.log") as f:
parser.read(f)

packet_tree = parser.games[0] # first game

game = packet_tree.export().game
```


## License

Expand Down