chor(socha): bump up to 2.0.2

fix(socha): build on linux fix(socha): build on linux fix(socha): build on linux fix(socha): build on linux test(push): fix wrong test chor(readme): update with docs info chor(rtfd): rename docs: auto update index.rst chor(docs): correct deps chor(docs): correct deps chor(docs): correct doc link
software-challenge · Nov 12, 2023 · 5f9e54c · 5f9e54c
1 parent 050c846
commit 5f9e54c
Show file tree

Hide file tree

Showing 17 changed files with 59 additions and 141 deletions.
diff --git a/readthedocs.yaml → .readthedocs.yaml b/readthedocs.yaml → .readthedocs.yaml
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "_socha"
-version = "2.0.1"
+version = "2.0.2"
 edition = "2021"
 
 [lib]
@@ -13,7 +13,7 @@ libmath = "0.2.1"
 regex = "1.7.1"
 yaserde = "0.8.0"
 yaserde_derive = "0.8.0"
-pyo3 = { version = "0.20.0", features = ["auto-initialize"] }
+pyo3 = { version = "0.20.0" }
 pyo3-log = "0.9.0"
 log = "0.4.20"
 

diff --git a/README.md b/README.md
@@ -2,10 +2,20 @@
 
 # Python Client for the Software-Challenge Germany 2024
 
+[![Read the Docs](https://img.shields.io/readthedocs/socha-python-client.readthedocs?label=Docs)](https://socha-python-client.readthedocs.io/en/latest/)
+[![PyPI](https://img.shields.io/pypi/v/socha?label=PyPi)](https://pypi.org/project/socha/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/socha?label=Python)](https://pypi.org/project/socha/)
 [![Discord](https://img.shields.io/discord/233577109363097601?color=blue&label=Discord)](https://discord.gg/ARZamDptG5)
+[![Documentation](https://img.shields.io/badge/Software--Challenge%20-Documentation-%234299e1)](https://docs.software-challenge.de/)
 
 > **Be warned!** This package is currently experimental and has still a few known bugs. But please try it out and let us know if anything comes up.
 
+> Hey there! To help you out, it's best to start by checking out the
+> [documentation for this client](https://socha-python-client.readthedocs.readthedocs.io/en/latest/)
+> before you ask any questions or open an issue.
+> It'll provide you with some helpful information!
+
+
 This repository contains the Python package for the
 [Software-Challenge Germany](https://www.software-challenge.de), a programming competition for students. The students
 have to develop an artificial intelligence that plays and competes against other opponents in an annually changing game.

diff --git a/docs/conf.py b/docs/conf.py
@@ -5,17 +5,19 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'socha player template'
-copyright = '2022, Falcon'
-author = 'Falcon'
+project = 'socha python client'
+copyright = '2023, maxblan'
+author = 'maxblan'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'sphinx.ext.autodoc'
+    'autoapi.extension'
 ]
 
+autoapi_dirs = ['../python/socha']
+
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,12 +1,20 @@
 Python Client for the Software-Challenge Germany 2024
 =====================================================
 
-|Discord|
+|Read the Docs| |PyPI| |PyPI - Python Version| |Discord| |Documentation|
 
    **Be warned!** This package is currently experimental and has still a
    few known bugs. But please try it out and let us know if anything
    comes up.
 
+..
+
+   Hey there! To help you out, it's best to start by checking out the
+   `documentation for this
+   client <https://software-challenge-python-client.readthedocs.io/en/latest/>`__
+   before you ask any questions or open an issue. It'll provide you with
+   some helpful information!
+
 This repository contains the Python package for the `Software-Challenge
 Germany <https://www.software-challenge.de>`__, a programming
 competition for students. The students have to develop an artificial
@@ -306,8 +314,16 @@ can use a logic written in Python and make changes in the Rust code.
 Each time a change is made, ``maturin develop`` must be executed again
 to make the change visible to the Python code.
 
+.. |Read the Docs| image:: https://img.shields.io/readthedocs/software-challenge-python-client?label=Docs
+   :target: https://software-challenge-python-client.readthedocs.io/en/latest/
+.. |PyPI| image:: https://img.shields.io/pypi/v/socha?label=PyPi
+   :target: https://pypi.org/project/socha/
+.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/socha?label=Python
+   :target: https://pypi.org/project/socha/
 .. |Discord| image:: https://img.shields.io/discord/233577109363097601?color=blue&label=Discord
    :target: https://discord.gg/ARZamDptG5
+.. |Documentation| image:: https://img.shields.io/badge/Software--Challenge%20-Documentation-%234299e1
+   :target: https://docs.software-challenge.de/
 
 
 Indices and tables

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
-sphinx==4.0
-sphinx-autodoc-typehints==1.12.0
-furo==2022.4.7
-xsdata==22.7
+sphinx==6.1.0
+sphinx-autoapi==3.0.0
+furo==2023.9.10
+xsdata==22.9
diff --git a/docs/socha.api.networking.rst b/docs/socha.api.networking.rst
diff --git a/docs/socha.api.plugin.rst b/docs/socha.api.plugin.rst
diff --git a/docs/socha.api.protocol.rst b/docs/socha.api.protocol.rst
diff --git a/docs/socha.api.rst b/docs/socha.api.rst
diff --git a/docs/socha.rst b/docs/socha.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "socha"
-version = "2.0.1"
+version = "2.0.2"
 authors = [{ name = "maxblan", email = "[email protected]" }]
 description = "This is the package for the Software-Challenge Germany 2023. This Season the game will be 'Hey, danke für den Fisch' a.k.a. 'Penguins' in short."
 readme = "README.md"

diff --git a/python/socha/__init__.pyi → python/socha/_socha.pyi b/python/socha/__init__.pyi → python/socha/_socha.pyi
diff --git a/src/plugin/actions/accelerate.rs b/src/plugin/actions/accelerate.rs
@@ -88,6 +88,8 @@ impl Accelerate {
 
 #[cfg(test)]
 mod tests {
+    use pyo3::prepare_freethreaded_python;
+
     use crate::plugin::board::Board;
     use crate::plugin::constants::PluginConstants;
     use crate::plugin::coordinate::{ CubeCoordinates, CubeDirection };
@@ -145,6 +147,7 @@ mod tests {
 
         let result_error: PyErr = accelerate.perform(&game_state).unwrap_err();
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(result_error.value(py).to_string(), AccelerationProblem::ZeroAcc.message());
         });
@@ -156,6 +159,7 @@ mod tests {
 
         let result_error = accelerate.perform(&game_state).unwrap_err();
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(
                 result_error.value(py).to_string(),
@@ -170,6 +174,7 @@ mod tests {
 
         let result = accelerate.perform(&game_state).unwrap_err();
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(result.value(py).to_string(), AccelerationProblem::BelowMinSpeed.message());
         });
@@ -185,6 +190,7 @@ mod tests {
 
         let result = accelerate.perform(&mute_state).unwrap_err();
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(
                 result.value(py).to_string(),

diff --git a/src/plugin/actions/advance.rs b/src/plugin/actions/advance.rs
@@ -77,6 +77,8 @@ impl Advance {
 
 #[cfg(test)]
 mod tests {
+    use pyo3::prepare_freethreaded_python;
+
     use crate::plugin::board::Board;
     use crate::plugin::coordinate::{ CubeCoordinates, CubeDirection };
     use crate::plugin::field::Field;
@@ -158,6 +160,7 @@ mod tests {
         assert!(result.is_err());
         let error: PyErr = result.unwrap_err();
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(error.value(py).to_string(), AdvanceProblem::InvalidDistance.message());
         });
@@ -173,6 +176,7 @@ mod tests {
         assert!(result.is_err());
         let error: PyErr = result.unwrap_err();
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(
                 error.value(py).to_string(),

diff --git a/src/plugin/actions/push.rs b/src/plugin/actions/push.rs
@@ -92,6 +92,8 @@ impl Push {
 
 #[cfg(test)]
 mod tests {
+    use pyo3::prepare_freethreaded_python;
+
     use crate::plugin::board::Board;
     use crate::plugin::coordinate::{CubeCoordinates, CubeDirection};
     use crate::plugin::field::Field;
@@ -159,7 +161,7 @@ mod tests {
         let new_ship: Ship = result.unwrap();
 
         assert_eq!(new_ship.position, CubeCoordinates::new(1, 0));
-        assert_eq!(new_ship.free_turns, 1);
+        assert_eq!(new_ship.free_turns, 2);
     }
 
     #[test]
@@ -207,6 +209,7 @@ mod tests {
 
         assert!(result.is_err());
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(
                 result.unwrap_err().value(py).to_string(),
@@ -227,6 +230,7 @@ mod tests {
 
         assert!(result.is_err());
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(
                 result.unwrap_err().value(py).to_string(),
@@ -247,6 +251,7 @@ mod tests {
 
         assert!(result.is_err());
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(
                 result.unwrap_err().value(py).to_string(),

diff --git a/src/plugin/actions/turn.rs b/src/plugin/actions/turn.rs
@@ -67,6 +67,8 @@ impl Turn {
 
 #[cfg(test)]
 mod tests {
+    use pyo3::prepare_freethreaded_python;
+
     use crate::plugin::board::Board;
     use crate::plugin::coordinate::{CubeCoordinates, CubeDirection};
     use crate::plugin::field::{Field, FieldType};
@@ -148,6 +150,7 @@ mod tests {
 
         assert!(result.is_err());
 
+        prepare_freethreaded_python();
         Python::with_gil(|py| {
             assert_eq!(
                 result.unwrap_err().value(py).to_string(),