Fix/readme (pnxenopoulos#269)

* fix readme + example nb

* 1.3.0!

* add map control to docs

README.md

@@ -89,13 +89,12 @@ Take a look at the following Jupyter notebooks provided in our `examples/` direc
 - [Basic CSGO visualization](https://github.com/pnxenopoulos/awpy/blob/main/examples/02_Basic_CSGO_Visualization.ipynb)
 - [Working with navigation meshes](https://github.com/pnxenopoulos/awpy/blob/main/examples/03_Working_with_Navigation_Meshes.ipynb)
 - [Advanced navigation functionality](https://github.com/pnxenopoulos/awpy/blob/main/examples/04_Advanced_Navigation_Functionality.ipynb)
+- [Map control](https://github.com/pnxenopoulos/awpy/blob/main/examples/05_Map_Control_Calculations_And_Visualizations.ipynb)
 
-If you use the parser for any analysis on Twitter, we kindly ask you to link to this repository, so that others may know how you parsed your data. If you have a paper or project that uses the parser, please let us know in Discord so we can add it!
+If you use the parser for any public analysis, we kindly ask you to link to this repository, so that others may know how you parsed, analyzed or visualized your data. If you have a paper or project that uses the parser, please let us know in Discord so we can add it!
 
 ## Contributing
-We welcome any contributions from the community. You can visit the [issue page](https://github.com/pnxenopoulos/awpy/issues) to see what issues are still open, or you can message on Discord. We will always have a need for writing tests, quality assurance and expanding functionality. We also seek contributors to produce interesting content (such as tweets, analyses, papers, etc.) -- you can see more examples of community content [here](https://awpy.readthedocs.io/en/latest/projects.html).
-
-When contributing code, be sure to lint your code using `black`, run the tests using `pytest`, and add any documentation (main modules are automatically covered, just make sure you write the documentation in the function).
+We welcome any contributions from the community. You can visit the [issue page](https://github.com/pnxenopoulos/awpy/issues) to see what issues are still open, or you can message on Discord. We will always have a need for writing tests, quality assurance and expanding functionality. We also seek contributors to produce interesting content (such as tweets, analyses, papers, etc.) -- you can see more examples of community content [here](https://awpy.readthedocs.io/en/latest/projects.html). If you are interested in contributing to Awpy, learn more [here](https://github.com/pnxenopoulos/awpy/blob/main/CONTRIBUTING.md).
 
 ## Structure
 `awpy` is structured as follows:

awpy/__init__.py

@@ -1,4 +1,4 @@
 """Provides data parsing, analytics and visualization capabilities for CSGO data."""
 from awpy.parser import DemoParser
 
-__version__ = "1.2.3"
+__version__ = "1.3.0"

docs/analytics.rst

@@ -1,7 +1,15 @@
 Analytics
 ================
 
-This is the analytics module. You can use it to calculate statistics on your parsed demos, such as Rating, ADR, and so on.
+This is the analytics module. You can use it to calculate statistics on your parsed demos, such as Rating, ADR, and so on. It also provides awpy-exclusive statistics, like map control.
+
+awpy.analytics.map_control
+-------------------------
+
+.. automodule:: awpy.analytics.map_control
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 awpy.analytics.nav
 -------------------------

docs/conf.py

@@ -29,7 +29,7 @@
 # The short X.Y version
 version = ""
 # The full version, including alpha/beta/rc tags
-release = "1.2.3"
+release = "1.3.0"
 
 
 # -- General configuration ---------------------------------------------------

examples/00_Parsing_a_CSGO_Demofile.ipynb

@@ -92,7 +92,7 @@
     }
    ],
    "source": [
-    "for k in data.keys():\n",
+    "for k in data:\n",
     "    if k != \"gameRounds\":\n",
     "        print(k + \": \" + str(data[k]))"
    ]
@@ -165,7 +165,7 @@
     }
    ],
    "source": [
-    "for k in data[\"gameRounds\"][7][\"kills\"][0].keys():\n",
+    "for k in data[\"gameRounds\"][7][\"kills\"][0]:\n",
     "        print(k + \": \" + str(data[\"gameRounds\"][7][\"kills\"][0][k]))"
    ]
   },
@@ -214,7 +214,7 @@
     }
    ],
    "source": [
-    "for k in data[\"gameRounds\"][7][\"damages\"][0].keys():\n",
+    "for k in data[\"gameRounds\"][7][\"damages\"][0]:\n",
     "        print(k + \": \" + str(data[\"gameRounds\"][7][\"damages\"][0][k]))"
    ]
   },
@@ -249,7 +249,7 @@
     }
    ],
    "source": [
-    "for k in data[\"gameRounds\"][7][\"grenades\"][0].keys():\n",
+    "for k in data[\"gameRounds\"][7][\"grenades\"][0]:\n",
     "        print(k + \": \" + str(data[\"gameRounds\"][7][\"grenades\"][0][k]))"
    ]
   },
@@ -277,7 +277,7 @@
     }
    ],
    "source": [
-    "for k in data[\"gameRounds\"][6][\"bombEvents\"][0].keys():\n",
+    "for k in data[\"gameRounds\"][6][\"bombEvents\"][0]:\n",
     "        print(k + \": \" + str(data[\"gameRounds\"][6][\"bombEvents\"][0][k]))"
    ]
   },
@@ -312,7 +312,7 @@
     }
    ],
    "source": [
-    "for k in data[\"gameRounds\"][7][\"weaponFires\"][0].keys():\n",
+    "for k in data[\"gameRounds\"][7][\"weaponFires\"][0]:\n",
     "        print(k + \": \" + str(data[\"gameRounds\"][7][\"weaponFires\"][30][k]))"
    ]
   },
@@ -1183,7 +1183,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.5"
+   "version": "3.11.0"
   }
  },
  "nbformat": 4,

setup.py

@@ -7,7 +7,7 @@
 
 setup(
     name="awpy",
-    version="1.2.3",
+    version="1.3.0",
     packages=find_packages(),
     # Project uses reStructuredText, so ensure that the docutils get
     # installed or upgraded on the target machine