refined registration

.github/workflows/gh-build.yml

@@ -0,0 +1,31 @@
+name: gh-build
+
+on:
+    push:
+        branches: ["main"]
+    pull_request:
+        branches: ["main"]
+
+jobs:
+  build_ghuser_components:
+    runs-on: windows-latest
+    name: Build components
+    steps:
+      - uses: actions/checkout@v2
+      - uses: NuGet/[email protected]
+
+      - name: Install CPython and pythonnet package
+        run: |
+          choco install python --version=3.9.10
+          python -m pip install pythonnet==3.0.3
+
+      - uses: compas-dev/compas-actions.ghpython_components@v5
+        with:
+          source: src/gh/components
+          target: build
+          interpreter: cpython
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: ghuser-components
+          path: build

.gitmodules

@@ -14,3 +14,6 @@
 [submodule "deps/loguru"]
 	path = deps/loguru
 	url = https://github.com/emilk/loguru.git
+[submodule "deps/pybind11"]
+	path = deps/pybind11
+	url = https://github.com/pybind/pybind11.git

CMakeLists.txt

@@ -16,6 +16,12 @@ if(NOT GIT_SUBMOD_RESULT EQUAL "0")
     message(FATAL_ERROR "git submodule update --init --recursive failed with ${GIT_SUBMOD_RESULT}, please checkout submodules")
 endif()
 
+#--------------------------------------------------------------------------
+# pre-compiled definitions
+#--------------------------------------------------------------------------
+if(SILENT_LOGGING)
+    target_compile_definitions(${PROJECT_NAME} PRIVATE SILENT_LOGGING=true)
+endif()
 
 #--------------------------------------------------------------------------
 # pre-compiled definitions

CONTRIBUTING.md

@@ -48,13 +48,120 @@ git add .gitmodules
 git commit -m "Remove a submodule name"
 ```
 
+---
+# Python
+DiffCheck is distributed as a Python Grasshopperr plug-in via yak and its source code via PyPI. The plug-in is composed by a series of `.ghuser` components.
+
+There are 3 ways you can contribute to the Python GH plug-in:
+1. By adding new components to the plug-in.
+2. By fixing bugs of existing components in the plug-in.
+3. By adding new functionalities to existing components in the plug-in.
+
+Before committing to the repository you need to have tested the components in the Grasshopper environment and be sure that this is working correctly. Also, provide a sufficient documentation in the PR (for now) please.
+
+Follow these steps to develop and test the Python GH plug-in:
+- [GHPy: A) preparation](#ghpy-a-preparation)
+- [GHPy: B) development/debug](#ghpy-b-developmentdebug)
+- [GHPy: C) Release](#ghpy-c-release)
+- [GHPy: D) Documentation](#ghpy-d-documentation)
+
+## GHPy: A) preparation
+Download this repo if you haven't already.
+```terminal
+git clone https://github.com/diffCheckOrg/diffCheck.git
+```
+
+Next, if you used diffCheck before as an end-user clean all the `diffCheck folders` in the following directory (the last name will change):
+```terminal
+C:\Users\<user-name>\.rhinocode\py39-rh8\site-envs\default-wMh5LZL3
+```
+> note that if you drop an official released diffCheck component from yak, this one will have the `#r : diffCheck==<version_number>` notation at the top of the script. Get rid of all these release components before to start and be sur to erase again the previous folders (they recreated each time `#r : diffCheck` is called).
+
+Build the package from the py source code's directory:
+```py
+python setup.py sdist bdist_wheel
+```
+
+Lastly, install the pip pacakge from the repository in editable mode. This way, all the modifications made to the source code of the repository will be reflected in the installed package. Open a terminal and run the following command (replace the path with where you download the repository):
+```terminal
+C:\Users\<your-username>\.rhinocode\py39-rh8\python.exe -m pip install -e "<path-to-repository-root>\src\gh\diffCheck"
+```
+
+For your info the packages is installed in `C:\Users\andre\.rhinocode\py39-rh8\Lib\site-packages`.
+
+That's it you are now a contributor to the diffCheck! We raccomand to not download anymore from yak package but rather use the source code in the repository. If you want the latest diffCheck, checkout and pull the main.
+
+## GHPy: B) development/debug
+
+### B.1) Code structure
+For DiffCheck there are 2 main folders in the repository:
+* `src/gh/diffCheck/components` here you can add new components or modify existing ones (for more info on how to create one we point you to [this documentation](https://github.com/compas-dev/compas-actions.ghpython_components)). Here we call the 
+* `src/gh/diffCheck/diffCheck` this is our package where the core functionalities are implemented.
+
+### B.2) Developing component's content
+The idea is to start by developing the content of the component in the file `src/gh/diffCheck/diffCgeck_app.py`. This would be a simple script that contains the logic of the component. Once the script `diffCheck_app.py` is working correctly, you can move the code to the component file in the `src/gh/diffCheck/components` folder. This is because the component file is the one that will be componentized and distributed via yak.
+
+We reccomand to use `VSCode` as IDE for developing the components. This is because it has a good integration with the `Grasshopper` environment and it is easy to debug the components. To set up the IDE follow these steps:
+1. Install the `ScriptSync` extension for `VSCode`.
+2. Install the `ScriptSync` from the yak manager in Rhino.
+3. Open the `diffCheckApp.py` from the `src/gh/diffCheck/components` folder you are working on in `VSCode`, and set its path to the ScriptSync ghcomponent.
+4. If you modify the code in `VSCode`, the changes will be reflected in the Grasshopper component as soon as you save in `VSCode` again the `code.py`.
+5. Once your code is working, prepare the code and componentize it.
+
+If you want to use the GHEditor it's ok but everytime you modify the pakcage or the component's code, after any modifications you need to restart the Python interpreter from the ScriptEditor (`Tools > Reload Python3 (CPython) Engine`) and recompute the solution in Grasshopper.
+
+### B.3) Componentize the code
+Prepare your component as explained here. You can componentize it locally and test it in Grasshopper. Here's how to componentize:
+```terminal
+python f:\diffCheck\src\gh\util\componentizer_cpy.py --ghio "C:\Users\andre\.nuget\packages\grasshopper\8.2.23346.13001\lib\net48\" .\src\gh\components\ .\build\gh
+```
+> Note that you need to find the path to your GHIO folder. This is the folder where the `Grasshopper.dll` is located. E.g. You can find it in the `nuget` folder in the Rhino installation directory.
+
+Once you are sure that the component is working correctly, you can push the changes to the repository.
+
+## GHPy: C) Release
+The release will be made via CI from main. As a contributor you don't need to worry about this. The plug-in is componentized, pushed to yak/PyPI and the user can download the latest version from yak.
+
+## GHPy: D) Documentation
+More to come.
+
+
+<!-- ## PyPI
+To push the package to PyPI, you need to:
+1. Install the package `twine`:
+```bash
+pip install twine
+```
+2. Build the package:
+```bash
+python setup.py sdist bdist_wheel
+```
+3. Check the package:
+```bash
+twine check dist/*
+```
+4. Upload the package:
+```bash
+twine upload dist/*
+```
+Be sure to have the right to upload the package to the PyPI repository.
+To do so you need to set the `~/.pypirc` file with the following content:
+```bash
+[distutils]
+index-servers=pypi
+
+[pypi]
+  username = __token__
+  password = pypi-<your-TOKEN>
+``` -->
+
 ---
 # C++
 
 ### Naming & synthax convention
 Here's the naming convention for this project:
 - ` `: lowerCamelCase.
-- `type PrivateVariable`: public member of a class
+- `type PublicVariable`: public member of a class
 - `type m_PrivateVariable`: Hungarian notation with UpperCamelCase for private class members.
 - `static type s_StaticVariable`: Hungarian notation with UpperCamelCase for static members of class.
 - `APP_SPEC`: Constants with SNAKE_UPPER_CASE.

README.md

@@ -1,9 +1,12 @@
-# diffCheck
-<p align="left">
+<p align="center">
+    <img src="./assets/logo/logo_pixelized_bwvioelt.png" width="150">
+</p>
+<p align="center">
     <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/win-build.yml/badge.svg">
+    <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/gh-build.yml/badge.svg">
+    <img src="https://img.shields.io/pypi/v/diffCheck" href="https://pypi.org/project/diffCheck/">
 </p>
 
-Temporary repository for diffCheck
 
 ## Roadmap