Feature/vector plane class

.github/workflows/publish.yml

@@ -3,34 +3,22 @@ name: Publish CwMath Package
 on:
   push:
     branches:
-      - main
-    paths:
-      - 'src/**'
-      - 'setup.py'
+      - 'main'
 
 jobs:
   build-and-publish:
     name: Build and Publish
-    runs-on: ubuntu-20.04
-
+    runs-on: 'ubuntu-latest'
+    environment:
+          name: pypi
+          url: https://pypi.org/p/cwmath
+    permissions:
+      id-token: write
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: 3.9
-      - run: >-
-          python -m
-          pip install
-          build
-          --user
-      - run: >-
-          python -m
-          build
-          --sdist
-          --wheel
-          --outdir dist/
-          .
+          python-version: '3.10'
+      - run: pip install build
+      - run: python -m build
       - uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test_publish.yml

@@ -2,36 +2,25 @@ name: Test Publish CwMath Package
 
 on:
   push:
-    branches:
-      - develop
-    paths:
-      - 'src/**'
-      - 'setup.py'
+    branches-ignore:
+      - 'main'
 
 jobs:
   build-and-publish:
     name: Test Build and Publish
-    runs-on: ubuntu-20.04
-
+    runs-on: 'ubuntu-latest'
+    environment:
+          name: testpypi
+          url: https://test.pypi.org/p/cwmath
+    permissions:
+      id-token: write
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: 3.9
-      - run: >-
-          python -m
-          pip install
-          build
-          --user
-      - run: >-
-          python -m
-          build
-          --sdist
-          --wheel
-          --outdir dist/
-          .
+          python-version: '3.10'
+      - run: pip install build
+      - run: python -m build
       - uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          user: __token__
-          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
-          repository_url: https://test.pypi.org/legacy/
+          repository-url: https://test.pypi.org/legacy/

.github/workflows/tests.yml

@@ -0,0 +1,21 @@
+name: Python Math Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  run-math-tests:
+    name: Run Math Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - run: python -m pip install --upgrade pip
+      - run: pip install pip-tools
+      - run: pip-sync
+      - run: python -m pytest

.gitignore

@@ -2,11 +2,103 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-venv/
+*.so
+
+.Python
 build/
+develop-eggs/
 dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
 *.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+*.manifest
+*.spec
+
+pip-log.txt
+pip-delete-this-directory.txt
+
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+*.mo
+*.pot
+
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+instance/
+.webassets-cache
+
+.scrapy
+
 docs/_build/
+
+.pybuilder/
+target/
+
+.ipynb_checkpoints
+
+profile_default/
+ipython_config.py
+
+.pdm.toml
+
+__pypackages__/
+
+celerybeat-schedule
+celerybeat.pid
+
+*.sage.py
+
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+.spyderproject
+.spyproject
+
+.ropeproject
+
+/site
+
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+.pyre/
+
+.pytype/
+
+cython_debug/
+
 .idea/
-site/
-venv.zip
+.vscode/

.pip-tools.toml

@@ -0,0 +1,4 @@
+[tool.pip-tools]
+generate-hashes = true
+allow-unsafe = true
+strip-extras = true

.readthedocs.yaml

@@ -1,13 +1,13 @@
 version: 2
 
 build:
-  os: ubuntu-20.04
+  os: ubuntu-lts-latest
   tools:
-    python: "3.9"
+    python: "3.12"
 
 mkdocs:
   configuration: mkdocs.yml
 
 python:
    install:
-   - requirements: docs/requirements.txt
+   - requirements: requirements.txt

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Cadwork Informatique Inc.
+Copyright (c) 2024 Cadwork
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,3 +1,5 @@
+![Logo](https://filehost.cadwork.ca/cadwork_logo.png)
+
 # Cadwork Math Utilities
 
 [![PyPI](https://img.shields.io/pypi/v/cwmath)](https://pypi.python.org/pypi/cwmath/)
@@ -74,3 +76,35 @@ do_two()
 do_three()
 
 ```
+
+# Examples
+```python
+import cadwork
+import element_controller as ec
+import geometry_controller as gc
+
+import sys
+
+sys.path.append("...\\...\cwmath\\src")
+
+from cwmath import cwplane3d
+from cwmath import cwvector3d
+
+element_ids = ec.get_active_identifiable_element_ids()
+if len(element_ids) > 0:
+    point1 = gc.get_p1(*element_ids)
+    point2 = gc.get_p2(*element_ids)
+    yl = gc.get_yl(*element_ids)
+    plane = cwplane3d.CwPlane3d(point1,yl)
+    print(point1)
+    print(yl)
+    print(plane)
+
+    distance = plane.distance_to_point(cadwork.point_3d(0.,0.,0.))
+    print(distance)
+
+    vector1 = cwvector3d.CwVector3d.from_point_3d(point1)
+    vector2 = cwvector3d.CwVector3d.from_point_3d(point2)
+    norm =(vector2 - vector1).normalize()
+    print(norm)
+```

docs/functions.md

@@ -1,5 +1,5 @@
 # CwMath
 
-::: cwmath.cwmath
+::: src.cwmath.cwexamples
     options:
       show_source: true

docs/plane3d.md

@@ -0,0 +1,6 @@
+# CwPlane3d
+
+::: src.cwmath.cwplane3d
+    options:
+        show_root_heading: true
+        show_source: true