Merge branch 'developement' of https://github.com/evereux/pycatia into developement

Author: evereux

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.9.1
+
+* fixed DrawingDimValue.get_bault_text() and DrawingDimValue.get_ps_text().
+
 ## 0.9.0
 
 Please note the change to VisPropertySet.get_show() will break existing scripts where this is used.
@@ -14,6 +18,7 @@ Please note the change to VisPropertySet.get_show() will break existing scripts
   Thanks to @CossackLucas for reporting #263.
 * updated ParameterSet.all_parameters to return a Parameters collection object.
 * fixed DrawingDimension.get_boundary_box(). #275
+* many type hinting improvements / fixes.
 
 ## 0.8.3
 

README.rst

@@ -14,14 +14,12 @@ alpha software
 
 This is alpha software.
 
-All the test cases and examples work but there will be many issues outside of
-the test framework. The CATIA com interface is large and I've predominantly
-wrote tests for those areas I'm familiar. Any bugs that exist should be for the
-most part be quite easy to fix using those methods that do work as a reference.
+The CATIA com interface is large and I've predominantly wrote tests for those
+areas I'm familiar. Any bugs that exist should be easy to fix. There are many
+examples of fixes within the git repository history that can be learned from to
+fix remaining issues.
 
-I have limited access to CATIA licences / workbenches. Also, there are many
-modules that I simply don't know what they do. Thus my ability to test and
-support can be limited.
+My ability to test and support can be limited.
 
 
 Requirements
@@ -86,8 +84,8 @@ On the first run, during the running of the tests, the test suite will create
 the CATIA drawing, products and part it requires to run and adds them to the
 folder tests/cat_files.
 
-If you have previously run the tests successfully and see into strange errors,
-it maybe that the source parts require re-creating. Try deleting the CATIA files
+If you have previously run the tests successfully and see unexpected errors, it
+maybe that the source parts require re-creating. Try deleting the CATIA files
 in the folder tests/cat_files so that they are regenerated on the next test run.
 
 CATIA V5 should already be running and have NO documents already open.

docs/conf.py

@@ -32,11 +32,11 @@ def __getattr__(cls, name):
 # -- Project information -----------------------------------------------------
 
 project = 'pycatia'
-copyright = '2024, Paul Bourne'
+copyright = '2025, Paul Bourne'
 author = 'Paul Bourne'
 
 # The short X.Y version
-version = '0.9.0'
+version = '0.9.1'
 # The full version, including alpha/beta/rc tags
 release = version
 

docs/examples.rst

@@ -5,7 +5,7 @@ Examples
 
 Simple examples that help you get started using pycatia.
 
-For more complex scripts see the section on :ref:`User Scripts`.
+For more complex scripts see the section on :ref:`User Scripts<User Scripts>`.
 
 Index
 -----
@@ -404,7 +404,7 @@ Change the Length value of parameter named Thickness.
 
 
 
-.. _Example Part:
+.. _Example Parts:
 
 PART EXAMPLES
 ----------------

docs/installation.rst

@@ -129,11 +129,11 @@ Confirm Successful Install
 .. code-block:: python
 
     from pycatia import catia
-    caa = catia()
-    help(caa)
+    application = catia()
+    help(application)
     # q to quit help
     # open a new .CATPart
-    documents = caa.documents
+    documents = application.documents
     documents.add('Part')
 
 * To exit the python interpreter.

docs/introduction.rst

@@ -21,8 +21,8 @@ You will almost always want to import the `catia`
     from pycatia import catia
     from pycatia.mec_mod_interfaces.part_document import PartDocument
     # initialise the catia automation appliction. CATIA V5 should already be running.
-    caa = catia()
-    documents = caa.documents
+    application = catia()
+    documents = application.documents
 
 documents is an instance of the :ref:`Documents<Documents>`
 class.

docs/user_scripts.rst

@@ -3,7 +3,7 @@
 User Scripts
 ============
 
-User created scripts that are more advanced than the :ref:`examples`.
+User created scripts that are more advanced than the :ref:`Examples<examples>`.
 
 Index
 -----

examples/example__assembly_convertor__001.py

@@ -38,8 +38,8 @@
 # file_type can be "TXT", "HTML" or "XLS".
 file_type = "XLS"
 
-caa = catia()
-product_document: ProductDocument = caa.active_document
+application = catia()
+product_document: ProductDocument = application.active_document
 product = product_document.product
 
 bom = product.get_item("BillOfMaterial")

examples/example__bom_custom_001.py

@@ -27,8 +27,8 @@
 from pycatia import catia
 from pycatia.product_structure_interfaces.product_document import ProductDocument
 
-caa = catia()
-product_document: ProductDocument = caa.active_document
+application = catia()
+product_document: ProductDocument = application.active_document
 product = product_document.product
 products = product.products
 

examples/example__constraints_001.py

@@ -26,9 +26,9 @@
 from pycatia.enumeration.enumeration_types import cat_constraint_type
 from pycatia.product_structure_interfaces.product_document import ProductDocument
 
-caa = catia()
+application = catia()
 # if the active document is a CATProduct this will return a ProductDocument
-product_document: ProductDocument = caa.active_document
+product_document: ProductDocument = application.active_document
 product = product_document.product
 
 products = product.products