Merge pull request #33 from Dessia-tech/dev

Towards V2.0.0-rc.2

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v2.0.0-rc.2] - 26/11/2024
+
+### Added
+
+- Set up the remote repository to the new local Git repository
+- Add CI trigger on tag push for dist build
+- Update files extensions to skip in codespell
+
+### Fixed
+
+- Remove numpy dependency in unit tests
+
 
 ## [v2.0.0-rc.1] - 11/10/2024
 
@@ -43,7 +55,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- ‎Update README.md
+- Update README.md
 
 ## [v0.1.0] - 07/01/2021
 
@@ -53,5 +65,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## [v0.0.1] - 22/10/2020 (Initialization)
-
-

README.md

@@ -120,7 +120,7 @@ After filling in the .ini inputs file, run the create_package.py script to gener
 
    - Log in to your GitHub account
    - Click the "+" icon in the top-right corner and select "New repository"
-   - Choose a project name for your repository (the directory containing your package): The project name is the CamelCase version of the package name choosen in the .ini inputs file
+   - Choose a project name for your repository (the directory containing your package): The project name is the CamelCase version of the package name chosen in the .ini inputs file
    - Do not initialize the repository with a README, .gitignore, or license
    - Click "Create repository"
 

create_package.py

@@ -65,21 +65,20 @@ def replace_placeholders(_file_path: str, _placeholders: dict) -> None:
 
 # Initialize a new Git repository
 os.chdir(new_package_dir)  # Change directory to the new package directory
-subprocess.run(["git", "init"], check=False)  # Initialize a new git repository
-subprocess.run(["git", "add", "."], check=False)  # Add all files to staging
-subprocess.run(["git", "commit", "-m", "Initial commit"], check=False)  # Commit the changes
+subprocess.run(["git", "init"], check=True)  # Initialize a new git repository
+subprocess.run(["git", "add", "."], check=True)  # Add all files to staging
+subprocess.run(["git", "commit", "-m", "Initial commit"], check=True)  # Commit the changes
 
 # Rename the default branch to 'master'
-subprocess.run(["git", "branch", "-M", "master"], check=False)
+subprocess.run(["git", "branch", "-M", "master"], check=True)
 
 if parameters["package_url"]:
-    # Set up the upstream repository and push
-    push_command = (
-        f"git push --set-upstream git@{parameters['package_url']}/"
-        f"$(git rev-parse --show-toplevel | xargs basename).git "
-        f"$(git rev-parse --abbrev-ref HEAD)"
-    )
-    subprocess.run(push_command, shell=True, check=False)
+    # Set up the remote repository
+    remote_url = f"git@{parameters['package_url']}/{parameters['project_package_name']}.git"
+    subprocess.run(["git", "remote", "add", "origin", remote_url], check=True)
+
+    # Push to the remote repository
+    subprocess.run(["git", "push", "-u", "origin", "master"], check=True)
 
     print(f"\nA new Git repository has been initialized in {new_package_dir}.")
 

methods/methods_get_parameters_from_ini_file.py

@@ -14,7 +14,7 @@
 
 
 def read_config_to_dict(file_path: str) -> dict:
-    """"Read a configuration file and returns its contents as a dictionary, excluding the 'DOCUMENTATION' section."""
+    """Read a configuration file and returns its contents as a dictionary, excluding the 'DOCUMENTATION' section."""
     config = configparser.ConfigParser()
     config.read(file_path)
 

package_folder/.gitlab-ci.yml

@@ -5,6 +5,7 @@ stages:
   - verify
   - check
   - test
+  - build
 
 
 # Verify that the changelog has been updated
@@ -60,7 +61,7 @@ install_run_scripts_and_unittests:
 
 # Generate dist wheel and source distribution on master branch
 generate_dist_wheel:
-  stage: test
+  stage: build
   tags:
     - dessia_ubuntu
   image: python:3.9
@@ -70,6 +71,7 @@ generate_dist_wheel:
   rules:
     - if: '$CI_COMMIT_BRANCH == "master"'
     - if: '$CI_COMMIT_BRANCH == "testing"'
+    - if: '$CI_COMMIT_TAG'
   artifacts:
     paths:
       - dist/*.whl

package_folder/pyproject.toml

@@ -31,7 +31,7 @@ convention = "pep257"
 "tests/**/*.py" = ["D"]  # documenting the unit tests is not necessary
 
 [tool.codespell]
-skip = ["*.json", "*.html", "*.js", "*.css", ".c", ".h", ".cpp", ".hpp", "*.xml"]
+skip = ["*.json", "*.html", "*.js", "*.css", "*.c", "*.h", "*.cpp", "*.hpp", "*.xml", "*.stp", "*.step", "*.CATPart"]
 ignore-words-list = ["dessia"]  # words to ignore from codespell check
 
 [tool.coverage.run]

package_folder/tests/test_exemple.py

@@ -1,12 +1,10 @@
 import unittest
 
-import numpy as np
-
 
 class TestClassName(unittest.TestCase):
     def test_method_name(self) -> None:
         results = [0, 3, 0]
-        self.assertTrue(np.all(results == np.array([0, 3, 0])))
+        self.assertEqual([0, 3, 0], results)
 
 
 if __name__ == "__main__":