diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8f3539dd7..c334c4d9d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,12 +3,6 @@ name: build on: - push: - branches: [main, dev] - paths: - - "awpy/**" - - "tests/**" - - "pyproject.toml" pull_request: branches: [main] paths: diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index aed1d05eb..da7911654 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,8 +14,10 @@ jobs: - uses: actions/checkout@v4 with: fetch-depth: 0 # otherwise, you will failed to push refs to dest repo - - name: Build and commit - uses: sphinx-notes/pages@v2 + - name: Build Sphinx docs + uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" - name: Push changes uses: ad-m/github-push-action@master with: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e53eb9d67..9c58ab294 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -27,7 +27,7 @@ jobs: run: | poetry config virtualenvs.create true --local poetry config virtualenvs.in-project true --local - poetry config repositories.testpypi https://test.pypi.org/simple/ + poetry config repositories.testpypi https://test.pypi.org/legacy/ - name: Install awpy run: | diff --git a/docs/conf.py b/docs/conf.py index 808a5fd5d..8c899a758 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,7 @@ # The short X.Y version version = "" # The full version, including alpha/beta/rc tags -release = "2.0.0-alpha" +release = "2.0.0a3" # -- General configuration --------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 0c3d1759e..7076dcae9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,37 +16,37 @@ awpy .. |Build| image:: https://github.com/pnxenopoulos/awpy/actions/workflows/build.yml/badge.svg :target: https://github.com/pnxenopoulos/awpy/actions/workflows/build.yml -.. |Licence| image:: https://img.shields.io/badge/license-MIT-lightgrey +.. |License| image:: https://img.shields.io/badge/license-MIT-lightgrey :target: https://github.com/pnxenopoulos/awpy/blob/main/LICENSE -`awpy` allows a user to parse, analyze and visualize Counter-Strike demo files. You can visit the repository_ to view the source code, examples and data. Please join the Discord_ server if you would like to join our esports analytics community or to receive help with the library. To install the library, run ``pip install awpy`` (Python >= 3.11). +`awpy` allows a user to parse, analyze and visualize Counter-Strike 2 demo files. You can visit the repository_ to view the source code, examples and data. Please join the Discord_ server if you would like to join our esports analytics community or to receive help. To install the library, run ``pip install awpy`` (Python >= 3.9). .. _repository: https://github.com/pnxenopoulos/awpy .. _Discord: https://discord.gg/W34XjsSs2H -Using Awpy to parse Counter-Strike demos is as easy as the few lines of code shown below. To see what output looks like, check out :doc:`parser_output`. +Using Awpy to parse Counter-Strike 2 demos is as easy as the few lines of code shown below. To see what output looks like, check out :doc:`parser_output`. .. code-block:: python - from awpy import parse_demo + from awpy import Demo - # Parse a demo file in one line! - demo = parse_demo(file="og-vs-natus-vincere-m1-dust2.dem") + # Simply call `Demo(path="...")` to parse a demo + dem = Demo("natus-vincere-vs-virtus-pro-m1-overpass.dem") - # The `demo` object contains a variety of keys - demo.header # Header information like the map, tick rate, etc. - demo.rounds # A list of rounds and their start/end ticks - demo.kills # Kills and their details - demo.damages # Damage dealt by each player - demo.grenades # Grenade throws and their trajectories - demo.effects # Smokes & mollies - demo.flashes # When a player is flashed - demo.weapon_fires # Shots fired by each player - demo.bomb_events # Include plants, defuses, plant_start, defuse_start, etc. - demo.ticks # A list of each player's info at each tick + # Access various dictionaries & dataframes + dem.header + dem.rounds + dem.grenades + dem.kills + dem.damages + dem.bomb + dem.smokes + dem.infernos + dem.weapon_fires + dem.ticks -Using awpy +Using Awpy ---------- :doc:`installation` How to install `awpy`. @@ -54,9 +54,6 @@ Using awpy :doc:`examples` Examples code and Jupyter notebooks to help get you started. -:doc:`projects` - Projects that use `awpy`. - :doc:`faq` Need help? Check the FAQs first. @@ -68,13 +65,13 @@ awpy Modules :doc:`data` Data module. -:doc:`parser` - Parsing module. +:doc:`parsing` + Parsing modules. :doc:`stats` Stats module. -:doc:`visualization` +:doc:`vis` Visualization module. .. Hidden TOCs diff --git a/docs/projects.rst b/docs/projects.rst deleted file mode 100644 index 6dbdb0a2e..000000000 --- a/docs/projects.rst +++ /dev/null @@ -1,28 +0,0 @@ -Projects -======== - -The following is a list of projects that rely on `awpy` or its past versions. Please reach out on Discord_ if you would like your project featured here. - -.. _Discord: https://discord.gg/W34XjsSs2H - -Papers -###### - Xenopoulos, P., Freeman, B., & Silva, C. (2022) `Analyzing the Differences between Professional and Amateur Esports through Win Probability `_ In 2022 ACM Web Conference (WWW). - - Xenopoulos, P., Rulff, J., & Silva, C. (2022). `ggViz: Accelerating Large-Scale Esports Game Analysis `_. 2021 AISA Workshop (IJCAI). - - Xenopoulos, P., & Silva, C. (2021). `Graph Neural Networks to Predict Sports Outcomes `_. In 2021 IEEE International Conference on Big Data (Big Data). - - Xenopoulos, P., Doraiswamy, H., & Silva, C. (2020). `Valuing Player Actions in Counter-Strike: Global Offensive `_. In 2020 IEEE International Conference on Big Data (Big Data). - -Social Media -############## -`IEM Fall 2021 - EU - Weapons Analysis `_ - -`CS: Vizion, a system to retrieve CSGO game states `_ - -`Aleksib dust2 grenade map `_ - -`Map Control `_ \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 8f9a5cb8c..76bddbbcc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] name = "awpy" -version = "2.0.0a2" +version = "2.0.0a3" description = "Counter-Strike 2 demo parsing, analysis and visualization" readme = "README.md" authors = [ @@ -16,7 +16,6 @@ keywords = ["counter-strike 2", "counter-strike", "csgo", "esports", "sports-ana classifiers = [ "License :: OSI Approved :: MIT License", "Intended Audience :: Science/Research", - "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11",