Skip to content

Commit 453a5bb

Browse files
Update README.md
1 parent 2b69da6 commit 453a5bb

1 file changed

Lines changed: 32 additions & 2 deletions

File tree

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
# pythonChessAnalyzer
2-
Analyses games and positions. Possible to have a Game Report similar to the one from chess.com, including graphs.
1+
# pythonChessAnalyzer
2+
3+
Analyses games and positions. Possible to have a Game Report similar to the one from chess.com, including graphs.
4+
Also has a Coordinate trainer(author: [Stephen Ryan](https://github.com/stephen70))
5+
6+
## Installation
7+
8+
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install pythonChessAnalyzer.
9+
10+
```bash
11+
pip install chessAnalyzer
12+
```
13+
14+
## Usage
15+
16+
```python
17+
import chessAnalyzer, os
18+
19+
ca = chessAnalyzer.main.AnnotatePosition(0.5, os.cwd(), <engine(optional)>)
20+
21+
ca.graph(pgn_loc, end_loc) # creates a graph
22+
annotated_pgn = ca.annotate_game(pgn_loc) # annotates game
23+
ca.train_coordinates() # trains coordinates
24+
white_lost_positions: list, black_lost_positions: list, annotated game: list = ca.game_report(pgn_loc, annotate=True) # gets you a game report(saves graph elsewhere)
25+
# and more!
26+
```
27+
28+
## Contributing
29+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
30+
31+
## License
32+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)