Merge branch 'developement'

Author: evereux

.gitignore

@@ -140,7 +140,6 @@ pycatia-exe.build
 pycatia-exe.dist
 zip_win32_dist.py
 win_32/pycatia
-pycatia-exe.py
 logo*
 *.cgr
 

CHANGELOG.md

@@ -1,19 +1,87 @@
 # Changelog
 
+## 0.6.0
+
+* Removed deprecated method Product.get_products() use Product.products instead.
+* Added the following new modules:
+    * abq_automation_interfaces
+    * analysis_interfaces
+    * arrangement_interfaces
+    * assembly_interfaces
+    * behaviour_interfaces
+    * bkt_interfaces
+    * cat_dde_settings_interfaces
+    * cat_ipd_adapter_interfaces
+    * cat_plant_ship_interfaces (PSP)
+    * cat_rdg_interfaces
+    * cat_rsc_interfaces
+    * cat_sch_platform_interfaces
+    * cat_sde_interfaces
+    * cat_sm_interfaces
+    * cat_smarteam_integ_interfaces
+    * cat_str_functional_interfaces
+    * cat_tps_interfaces
+    * catia_v4_interfaces
+    * catia_de_settings_interfaces
+    * composites_interfaces
+    * dnb_asy_activity_interfaces
+    * dnb_d5_interfaces
+    * dnb_device_activity_interfaces
+    * dnb_device_interfaces
+    * dnb_dpm_interfaces
+    * dnb_ehm_interfaces
+    * dnb_ehs_interfaces
+    * dnb_ekp_interfaces
+    * dnb_fastener_interfaces
+    * dnb_graph_editor
+    * dnb_human_modelling_interfaces
+    * dnb_human_sim_interfaces
+    * dnb_igp_arc_commands
+    * dnb_lgp_olp_ui
+    * dnb_igp_setup_interfaces
+    * dnb_manufacturing_layout_interfaces
+    * dnb_mhi_interfaces
+    * dnb_reporting_interfaces
+    * dnb_resource_program_interfaces
+    * dnb_robot_interfaces
+    * dnb_sim_activity_interfaces
+    * dnb_simulation_interfaces
+    * dnb_sor_interfaces
+    * dnb_state_interfaces
+    * dnb_work_interfaces
+    * dmaps_interfaces
+    * drafting_2dl_interfaces
+    * electrical_schematic_interfaces
+    * eno_cd5_interfaces
+    * fitting_interfaces
+    * general_knowledge_interfaces
+    * kinematics_interfaces
+    * manufacturing_interfaces
+    * multi_cad_interfaces
+    * osm_interfaces
+    * pcb_board_base
+    * ppr_interfaces
+    * prismatic_machining_interfaces
+    * reporter_interfaces
+    * simulation_interfaces
+    * smt_interfaces
+    * structure_interfaces
+    * surface_machining_interfaces
+    * threed_xml_interfaces
+
 ## 0.5.9
 
 * Added missing com_oject to references in navigator_interfaces. (@evereux & @marciolrc)
 * Fixed reference plane method in HybridShapePlaneAngle. (@Mithro86)
-* Updates to examples to include latest supported python version. Also fix IDE autocompletion & syntax highlighting 
- issues. (@deloarts)
-*  
+* Updates to examples to include latest supported python version. Also fix IDE autocompletion & syntax highlighting
+  issues. (@deloarts)
 
 ## 0.5.8
 
 * Added new document type CatalogDocument.
 * Added new document type CATMaterial.
-* fixed method for AxisSystem.origin_point, AxisSystem.x_axis_direction, AxisSystem.y_axis_direction and 
- AxisSystem.z_axis_direction. (@Mithro86)
+* fixed method for AxisSystem.origin_point, AxisSystem.x_axis_direction, AxisSystem.y_axis_direction and
+  AxisSystem.z_axis_direction. (@Mithro86)
 * Added warning to example__assembly_convertor__001.py for when writing to files. (@deloarts)
 * fixed method for Limit.limiting_element(). (@ptm-tm)
 
@@ -23,8 +91,7 @@
 * fixed method for AxisSystem.get_vectors(). (@Mithro86)
 * Partial fix to Selection.indicate_or_select_element_3d(). (@Mithro86)
 * added pathlib.Path to DrawingPictures.add().
-  * now tries to get the Windows absolute path from input as CATIA may not be 
-  able to otherwise find the file. 
+    * now tries to get the Windows absolute path from input as CATIA may not be able to otherwise find the file.
 * References to python 3.6 now updated to 3.9 due to type annotation support.
 * fixed method for Line.get_direction(). (@Mithro86)
 
@@ -49,8 +116,8 @@
 
 ## 0.5.3
 
-* fixed methods in pycatia/mec_mod_interfaces/axis_system and pycatia/mec_mod_interfaces/cylindrical_face.py
-  that required mapping to VBA methods.
+* fixed methods in pycatia/mec_mod_interfaces/axis_system and pycatia/mec_mod_interfaces/cylindrical_face.py that
+  required mapping to VBA methods.
 
 ## 0.5.2
 

CONTRIBUTING.md

@@ -2,40 +2,29 @@
 
 # Git / Github
 
-If you would like to contribute to pycatia there are a number of ways you can do
-this. 
+If you would like to contribute to pycatia there are a number of ways you can do this.
 
-If you contribution is to the codebase you should learn the basics of git / 
-github and how to create a fork of pycatia and then a new branch for your 
-specific pull request and creating the pull request itself. This can be done 
-via the github web interface itself and this is fine too but it's worth 
-learning git I think.
+If your contribution is to the codebase you should learn the basics of git and github and how to create a fork of
+pycatia and then a new branch for your specific pull request and creating the pull request itself.
 
-With your pull request please also submit a small section of code that 
-demonstrates how to use the class method you have added / fixed.
+With your pull request please also submit a small section of code that demonstrates how to use the class method you have
+added / fixed.
 
 # Which branch should I work on?
 
-The master branch represents the latest released version of pycatia. Any pull 
-requests against the pycatia application itself shall not be done to this 
-branch but the `developement` branch.
+The master branch represents the latest released version of pycatia. Any pull requests against the pycatia application
+itself shall not be done to this branch but the `developement` branch.
 
 However, changes to the documentation or examples can be done against either.
 
 ## Adding new modules
 
-If you would like to add a module to pycatia please see the contents of 
-`v5automation-autogenerated.7z`. This archive was created by scraping through 
-the contents of the V5Automation.chm help file to re-construct all the classes 
-and methods for python. It's largely complete but won't work out the box 
-without some tweaking. But these files should be the basis for any pull 
-requests. They will save you sometime and effort and ensure some consistency 
-for the project.
+I have now added all the modules I was able to extract from the documentation so there shouldn't be a need to add new
+modules as of 0.6.0.
 
 ## Scripts / Examples
 
-New scripts / examples are always welcome as they great for new users to 
-discover how to use pycatia.
+New scripts / examples are always welcome as they great for new users to discover how to use pycatia.
 
 If you have written a script using pycatia you would like to share you can:
 
@@ -45,7 +34,6 @@ If you have written a script using pycatia you would like to share you can:
 
 ## Tests
 
-There is a test framework in place that covers the basic set of pycatia 
-features. However, there is a lot of work to do here in expanding on those. 
-Pull-requests expanding on these tests would be very much appreciated.
+There is a test framework in place that covers the basic set of pycatia features. However, there is a lot of work to do
+here in expanding on those. Pull-requests expanding on these tests would be very much appreciated.
 

README.rst

@@ -10,15 +10,23 @@ pycatia
 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 huge and
-I'm currently just attacking the items I think will be most useful. The
-framework is in place for others to contribute so if you know CATIA and python
-please do contribute. Bonus points for adding tests too.
+This is alpha software.
 
-I have limited access to CATIA licences / workbenches so will not be able to
-support those I can't test. If your company would like support for additional
-workbenches adding to pycatia and can provide a license please contact me.
+All the test cases and examples work but there will be many issues outside of
+the test framework. The CATIA com interface is huge and I've predominantly
+only worked / tested on those I can figure out how to use.
+
+The entire framework is now in place for others to contribute so if you know
+CATIA and python (being already familiar with automation using the more
+traditional methods will help) please do contribute. Bonus points for adding
+tests too.
+
+I have limited access to CATIA licences / workbenches. Also, there's are many
+modules that I simply don't know what they do. Thus my ability to test things
+is extremely limited.
+
+All this said many bugs that exist should be for the most part be quite easy to
+fix using those methods that do work as a reference.
 
 
 Why was it made?
@@ -30,15 +38,13 @@ and it's methods without the need of visual basic / CATScripts.
 Some of the methods can be accessed directly using the pywin32 module but there
 are a number that just simply won't work using python. There are several
 questions on stack overflow and the pywin32 mailing list regarding this. But,
-they fail to provide any working examples with the Measurable object in python.
-
+they failed to provide any working examples with the Measurable object in python.
 
 pycatia accesses these methods by running VBA scripts using the 
 `Dispatch('CATIA.Application').SystemService.Evaluate()` function and passing a
 public function to it. Otherwise, pycatia uses the VB method directly but
 exposes it within the same python class.
 
-
 There is now further functionality available which can be seen by looking at
 the examples provided and reading the API at pycatia.readthedocs.io_.
 

api_builder.py

@@ -0,0 +1,86 @@
+"""
+    A simple script to generate API documentation for new modules.
+"""
+
+import os
+from pathlib import Path
+
+# module folder(s) within pycatia
+modules = ['threed_xml_interfaces']
+
+cwd = Path(os.getcwd())
+
+folder_doc_api = Path(cwd, 'docs/api')
+folder_pycatia = Path(cwd, 'pycatia')
+
+
+def get_index_contents(module_name):
+    folder = Path(folder_pycatia, module_name)
+    dir_contents = os.listdir(folder)
+
+    o = ''
+
+    for file in dir_contents:
+        if file == '__init__.py' or file == '__pycache__':
+            continue
+        f = file[0:-3]
+        o = o + f'   pycatia/{module_name}/{f}\n'
+
+    return o, dir_contents
+
+
+def build_index(module_name):
+    index_filename = Path(folder_doc_api, f'index_{module_name}.rst')
+
+    # if file already exists skip.
+    if index_filename.exists():
+        print(f'"{index_filename}" already exists.')
+        os.remove(index_filename)
+
+    header = f'pycatia.{module_name}\n'
+    header_underline = '=' * len(header)
+    toc_tree = '\n\n' \
+               '.. toctree::\n' \
+               '   :maxdepth: 1\n' \
+               '   :caption: Contents:\n\n\n'
+    contents, dir_content = get_index_contents(module_name)
+
+    text = header + header_underline + toc_tree + contents
+
+    print(f'creating file {index_filename}')
+    with open(index_filename, 'w') as file:
+        file.write(text)
+
+    return dir_content
+
+
+def build_api(module_name, dir_content):
+    module_api_folder = Path(folder_doc_api, 'pycatia', module_name)
+    # create the folder 
+    if not module_api_folder.exists():
+        print(f'Creating folder {module_api_folder}.')
+        os.mkdir(module_api_folder)
+
+    for file in dir_content:
+        m = file[0:-3]
+        if file == '__init__.py' or file == '__pycache__':
+            continue
+        f_api_name = Path(module_api_folder, f'{m}.rst')
+
+        header_link = f'.. _{module_name.capitalize()}:\n\n'
+        header = f'pycatia.{module_name}.{m}\n'
+        header_underline = '=' * len(header)
+        auto_module = f'\n\n.. automodule:: pycatia.{module_name}.{m}\n' \
+                      f'    :members:\n'
+
+        text = header_link + header + header_underline + auto_module
+
+        with open(f_api_name, 'w') as file:
+            file.write(text)
+
+
+for module_name in modules:
+    # build index
+
+    dir_content = build_index(module_name)
+    build_api(module_name, dir_content)

docs/api/index_abq_automation_interfaces.rst

@@ -0,0 +1,79 @@
+pycatia.abq_automation_interfaces
+==================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+
+   pycatia/abq_automation_interfaces/abqfh_output_request
+   pycatia/abq_automation_interfaces/abqiaabq_base_motion_vb
+   pycatia/abq_automation_interfaces/abqiaabq_frequency_loading_vb
+   pycatia/abq_automation_interfaces/abqiaabq_steady_state_lin_dyn_step_basic_vb
+   pycatia/abq_automation_interfaces/abqiaabq_steady_state_lin_dyn_step_modal_vb
+   pycatia/abq_automation_interfaces/abqiaabq_steady_state_lin_dyn_step_subspace_vb
+   pycatia/abq_automation_interfaces/abq_analysis_case
+   pycatia/abq_automation_interfaces/abq_analysis_cases
+   pycatia/abq_automation_interfaces/abq_analysis_model
+   pycatia/abq_automation_interfaces/abq_analytical_rigid_surface
+   pycatia/abq_automation_interfaces/abq_boundary_condition
+   pycatia/abq_automation_interfaces/abq_boundary_conditions
+   pycatia/abq_automation_interfaces/abq_clamp_bc
+   pycatia/abq_automation_interfaces/abq_concentrated_force
+   pycatia/abq_automation_interfaces/abq_damper_connection_property
+   pycatia/abq_automation_interfaces/abq_data_output_request
+   pycatia/abq_automation_interfaces/abq_data_output_requests
+   pycatia/abq_automation_interfaces/abq_displacement_bc
+   pycatia/abq_automation_interfaces/abq_display_group
+   pycatia/abq_automation_interfaces/abq_display_groups
+   pycatia/abq_automation_interfaces/abq_explicit_dynamics_step
+   pycatia/abq_automation_interfaces/abq_fastened_connection_enhancement
+   pycatia/abq_automation_interfaces/abq_fastened_pair
+   pycatia/abq_automation_interfaces/abq_fields
+   pycatia/abq_automation_interfaces/abq_field_output_request
+   pycatia/abq_automation_interfaces/abq_field_output_requests
+   pycatia/abq_automation_interfaces/abq_film_condition
+   pycatia/abq_automation_interfaces/abq_frequency_step
+   pycatia/abq_automation_interfaces/abq_gasket_property
+   pycatia/abq_automation_interfaces/abq_general_static_step
+   pycatia/abq_automation_interfaces/abq_global_element_assignment
+   pycatia/abq_automation_interfaces/abq_gravity
+   pycatia/abq_automation_interfaces/abq_heat_transfer_step
+   pycatia/abq_automation_interfaces/abq_history_output_request
+   pycatia/abq_automation_interfaces/abq_history_output_requests
+   pycatia/abq_automation_interfaces/abq_image_query
+   pycatia/abq_automation_interfaces/abq_initial_step
+   pycatia/abq_automation_interfaces/abq_initial_temperature
+   pycatia/abq_automation_interfaces/abq_interaction
+   pycatia/abq_automation_interfaces/abq_interactions
+   pycatia/abq_automation_interfaces/abq_job
+   pycatia/abq_automation_interfaces/abq_jobs
+   pycatia/abq_automation_interfaces/abq_load
+   pycatia/abq_automation_interfaces/abq_loads
+   pycatia/abq_automation_interfaces/abq_mass_scaling
+   pycatia/abq_automation_interfaces/abq_mass_scalings
+   pycatia/abq_automation_interfaces/abq_mech_conn_behavior
+   pycatia/abq_automation_interfaces/abq_output_request
+   pycatia/abq_automation_interfaces/abq_output_requests
+   pycatia/abq_automation_interfaces/abq_pressure
+   pycatia/abq_automation_interfaces/abq_pretension_property
+   pycatia/abq_automation_interfaces/abq_properties
+   pycatia/abq_automation_interfaces/abq_property
+   pycatia/abq_automation_interfaces/abq_rigid_body_constraint
+   pycatia/abq_automation_interfaces/abq_rigid_coupling
+   pycatia/abq_automation_interfaces/abq_smooth_coupling
+   pycatia/abq_automation_interfaces/abq_smooth_step_amplitude
+   pycatia/abq_automation_interfaces/abq_solution_case
+   pycatia/abq_automation_interfaces/abq_solution_case_images
+   pycatia/abq_automation_interfaces/abq_solution_step
+   pycatia/abq_automation_interfaces/abq_solution_steps
+   pycatia/abq_automation_interfaces/abq_solution_step_images
+   pycatia/abq_automation_interfaces/abq_spring_connection_property
+   pycatia/abq_automation_interfaces/abq_step
+   pycatia/abq_automation_interfaces/abq_steps
+   pycatia/abq_automation_interfaces/abq_surface_to_surface_contact
+   pycatia/abq_automation_interfaces/abq_tabular_amplitude
+   pycatia/abq_automation_interfaces/abq_temperature
+   pycatia/abq_automation_interfaces/abq_temperature_bc
+   pycatia/abq_automation_interfaces/abq_temperature_history
+   pycatia/abq_automation_interfaces/abq_thermal_conn_behavior