[CodeQuality] Pre-commit formatting (#87)

* pre commit

* amend

* test

* test

Author: matteobettini

.gitattributes

@@ -1,2 +1,2 @@
 notebooks/* linguist-documentation
-mpe_comparison/* linguist-documentation
+mpe_comparison/* linguist-documentation

.github/workflows/python-app.yml

@@ -46,4 +46,9 @@ jobs:
         pip install pytest 
         pip install pytest-cov
         pip install tqdm
-        pytest tests/ --doctest-modules --junitxml=junit/test-results.xml --cov=. --cov-report=xml --cov-report=html
+        pytest tests/ --doctest-modules --junitxml=junit/test-results.xml --cov=. --cov-report=xml --cov-report=html
+    - if: matrix.python-version == '3.10'
+      name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        fail_ci_if_error: false

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: check-docstring-first
+      - id: check-toml
+      - id: check-yaml
+        exclude: packaging/.*
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/omnilib/ufmt
+    rev: v2.0.0b2
+    hooks:
+      - id: ufmt
+        additional_dependencies:
+          - black == 22.3.0
+          - usort == 1.0.3
+          - libcst == 0.4.7
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        args: [--config=setup.cfg]
+        additional_dependencies:
+          - flake8-bugbear==22.10.27
+          - flake8-comprehensions==3.10.1

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to VMAS
+We want to make contributing to this project as easy and transparent as
+possible.
+
+## Installing the library
+
+To contribute, it is suggested to install the library (or your fork of it) from source:
+
+```bash
+git clone https://github.com/proroklab/VectorizedMultiAgentSimulator.git
+cd VectorizedMultiAgentSimulator
+python setup.py develop
+```
+
+## Formatting your code
+
+Before your PR is ready, you'll probably want your code to be checked. This can be done easily by installing
+```
+pip install pre-commit
+```
+and running
+```
+pre-commit run --all-files
+```
+from within the vmas cloned directory.
+
+You can also install [pre-commit hooks](https://pre-commit.com/) (using `pre-commit install`
+). You can disable the check by appending `-n` to your commit command: `git commit -m <commit message> -n`
+
+## Pull Requests
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite and the documentation pass.
+5. Make sure your code lints.
+
+When submitting a PR, we encourage you to link it to the related issue (if any) and add some tags to it.
+
+
+## License
+By contributing to vmas, you agree that your contributions will be licensed
+under the license of the project

MANIFEST.in

@@ -1 +1 @@
-include vmas/simulator/secrcode.ttf
+include vmas/simulator/secrcode.ttf

README.md

@@ -431,4 +431,4 @@ To create a fake screen you need to have `Xvfb` installed.
   - [X] simple_speaker_listener
   - [X] simple_spread
   - [X] simple_tag
-  - [X] simple_world_comm
+  - [X] simple_world_comm

mpe_comparison/mpe_performance_comparison.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2022.
+#  Copyright (c) 2022-2024.
 #  ProrokLab (https://www.proroklab.org/)
 #  All rights reserved.
 
@@ -14,14 +14,14 @@
 import numpy as np
 import tikzplotlib
 import torch
-from matplotlib import pyplot as plt
 
 import vmas
+from matplotlib import pyplot as plt
 
 
 def mpe_make_env(scenario_name):
-    from mpe.multiagent.environment import MultiAgentEnv
     import mpe.multiagent.scenarios as scenarios
+    from mpe.multiagent.environment import MultiAgentEnv
 
     # load scenario from script
     scenario = scenarios.load(scenario_name + ".py").Scenario()
@@ -44,10 +44,10 @@ def run_mpe_simple_spread(n_envs: int, n_steps: int):
     [env.reset() for env in envs]
     init_time = time.time()
 
-    for step in range(n_steps):
+    for _ in range(n_steps):
         for env_idx in range(n_envs):
             actions = []
-            for i in range(n_agents):
+            for _ in range(n_agents):
                 actions.append(simple_shared_action)
             envs[env_idx].step(actions)
 
@@ -72,9 +72,9 @@ def run_vmas_simple_spread(n_envs: int, n_steps: int, device: str):
     env.reset()
     init_time = time.time()
 
-    for step in range(n_steps):
+    for _ in range(n_steps):
         actions = []
-        for i in range(n_agents):
+        for _ in range(n_agents):
             actions.append(
                 torch.tensor(
                     simple_shared_action,
@@ -101,11 +101,11 @@ def get_device_name(torch_device: str):
                     if "model name" in line:
                         return re.sub(".*model name.*:", "", line, 1)
             else:
-                assert False
+                raise AssertionError()
     elif torch_device == "cuda":
         return torch.cuda.get_device_name()
     else:
-        assert False
+        raise AssertionError()
 
 
 def store_pickled_evaluation(name: str, evaluation: list):