Metadata-Version: 2.1
Name: chess-analytica
Version: 1.1.7
Summary: Making chess analytics easy.
Home-page: https://github.com/AronFrish/Chess-Analytica
Author: Aron Frishberg
Author-email: frishberg@uchicago.edu
License: MIT
Project-URL: Documentation, https://chess-analytica.readthedocs.io
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: Topic :: Games/Entertainment :: Board Games
Classifier: Topic :: Games/Entertainment :: Turn Based Strategy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: chess
Requires-Dist: urllib3

Chess-Analytica: Simplifying Chess Analytics
============================================

Introduction
------------
**Chess-Analytica** is a powerful chess library designed for effortless data scraping and analysis. Utilizing the chess.com API, it builds upon the robust `python-chess` library, enabling users to scrape and analyze past or current games of any player with ease.

Key Features:
- Easy scraping of game data from chess.com profiles.
- Advanced game filtering options.
- Comprehensive analysis of game patterns and styles.

Quick Start
-----------
Here's a glimpse of what you can do with Chess-Analytica:

    from chess_analytica import Board, ChessDotCom

    # Initialize and filter games
    profile = ChessDotCom.Profile("aronfrish", False)
    profile.filterGameType("rapid")

    # Analyze game terminations
    resignation_count = sum(1 for game in profile.games if "resignation" in game.termination)
    print(f"Rapid games ended in resignation: {resignation_count}")

    # Analyze specific openings
    italian_games = profile.find_games_with_FEN_and_Color("r1bqkbnr/pppp1ppp/2n5/4p3/2B1P3/5N2/PPPP1PPP/RNBQK2R", True)
    italian_game_percentage = len(italian_games) / len(profile.white_games)
    print(f"Italian games percentage (as white): {italian_game_percentage:.2%}")

Installation
------------
Easily install Chess-Analytica using pip:

    pip install chess-analytica

Documentation and Resources
---------------------------
Explore detailed documentation and examples to get the most out of Chess-Analytica:

- **Documentation**: `Full Documentation <https://chess-analytica.readthedocs.io/en/latest/>`_
- **Usage Examples**: `Examples <https://chess-analytica.readthedocs.io/en/latest/usage.html>`_
- **API Reference**: `ChessDotCom Class <https://chess-analytica.readthedocs.io/en/latest/chessdotcom.html>`_ | `Board Class <https://chess-analytica.readthedocs.io/en/latest/board.html>`_

License
-------
Chess-Analytica is open-sourced and available under the MIT License. For more details, see `LICENSE.txt`.
