Merge pull request #19 from RocketPy-Team/mnt/apply-pylint

Author: juliomachad0

.github/workflows/linter.yml

@@ -0,0 +1,28 @@
+name: Linter
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+        pip install -r requirements.in
+    - uses: psf/black@stable
+      with:
+        options: "--check ."
+        jupyter: true
+    - name: Run pylint
+      run: |
+        pylint rocketserializer/

.github/workflows/test-pytest.yaml

@@ -1,33 +1,40 @@
-name: PyTest
+name: pytest
 
 on:
   pull_request:
     types: [opened, synchronize, reopened, ready_for_review]
     paths:
       - "**.py"
+      - ".github/**"
+      - "pyproject.toml"
+      - "requirements*"
 
 jobs:
   run_pytest:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os:
-          - ubuntu-latest
-        python-version:
-          - 3.8
+        os: [ubuntu-latest, windows-latest]
+        python-version: [3.8, 3.12]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python-version }}
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+      - name: Build package
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements-dev.txt
-      - name: Build Package
+          pip install .
+      - name: Import package
         run: |
-          pip install -e .
-      - name: Test with pytest
+          python -c "import sys, rocketserializer; print(f'{rocketserializer.__name__} running on Python {sys.version}')"
+      - name: Install dev dependencies
         run: |
-          pytest
+          pip install -r requirements-dev.txt
+      # - name: Run pytest
+      #   run: |
+      #     pytest

pyproject.toml

@@ -0,0 +1,79 @@
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.in"]}
+
+[tool.setuptools]
+packages = { find = { where = ["."], include = ["rocketserializer*"] } }
+
+[project]
+name = "rocketserializer"
+version = "0.1.0"
+dynamic = ["dependencies"]
+requires-python = ">= 3.8"
+description = "Easily convert your OpenRocket files into RocketPy simulations."
+readme = "README.md"
+license = {file = "LICENSE.md"}
+authors = [
+    {name = "Guilherme Fernandes", email = "guilherme_fernandes@usp.br"},
+    {name = "Patrick Sampaio", email = "patricksampaio@usp.br"},
+    {name = "Julio Machado", email = "julioromac@outlook.com"},
+]
+maintainers = [
+    {name = "RocketPy Team", email = "rocketpyteam@gmail.com"},
+]
+keywords = [
+    "python",
+    "simulation",
+    "aerospace",
+    "motor",
+    "flight-simulator",
+    "trajectory", 
+    "trajectory-simulator",
+    "rocket-simulator",
+    "openrocket",
+    "rocket-simulation",
+]
+classifiers = [
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+[project.scripts]
+ork2json = "rocketserializer.cli:ork2json"
+ork2ipynb = "rocketserializer.cli:ork2ipynb"
+
+
+[project.urls]
+Documentation = "https://docs.rocketpy.org/en/latest/"
+Repository = "https://github.com/RocketPy-Team/RocketSerializer"
+Issues = "https://github.com/RocketPy-Team/RocketSerializer/issues"
+
+
+[tool.black]
+line-length = 88
+
+
+[tool.isort]
+profile = "black"
+
+
+[tool.pylint]
+max-line-length = 88
+disable = """
+    missing-module-docstring,
+    missing-function-docstring,
+    missing-class-docstring,
+    attribute-defined-outside-init,
+    too-many-locals,
+    too-many-arguments,
+    too-many-statements,
+    raise-missing-from,
+    fixme,
+    no-else-break,
+"""

requirements.txt

@@ -46,7 +46,7 @@ def extract_ork_from_zip(zip_path: Path, extract_dir: Path) -> Path:
         return extract_dir / "rocket.ork"
     except BadZipFile:
         logger.warning(
-            'The file "%s" seems to be a direct .ork file and not a compressed archive.',
+            'The file "%s" seems to be a rocket.ork file and not a compressed archive.',
             zip_path.as_posix(),
         )
         return zip_path
@@ -112,7 +112,7 @@ def _dict_to_string(dictionary, indent=0):
 
     Examples
     --------
-    >>> from open_rocket_serializer._helpers import _dict_to_string
+    >>> from rocketserializer._helpers import _dict_to_string
     >>> _dict_to_string({"a": 1, "b": {"c": 2}})
     " a: 1\n b: \n     c: 2\n"
     """