Update Documentation + llms.txt addition for vibe coding

.github/FUNDING.yml

@@ -1,8 +1,8 @@
 # These are supported funding model platforms
 
 github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: pyrevit
-open_collective: # Replace with a single Open Collective username
+patreon: # pyrevit
+open_collective: pyrevitlabs
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -7,49 +7,54 @@ body:
   - type: markdown
     attributes:
       value: |
-        > **🚧 If you have SentinelOne installed as an antivirus, look no further.**
-        > **You will need to create exceptions for Revit and pyRevit, both on the software and the %appdata% folders.**
+        ## Please fill this form properly! 🙏🙏🙏
+        We're running on limited resources, so we don't have much time to get back to you if you don't provide enough info.
+        Please make a little effort, do your research and [ask questions the smart way](http://www.catb.org/~esr/faqs/smart-questions.html#beprecise).
+        **If you didn't fill the form properly or lie about the pre-flight checks, the issue could be closed without any explanation!** 
+        ## 🚧🚧 Revit 2025 🚧🚧
+        pyRevit 4.8.x is not compatible with Revit 2025. If you really need it, you can try (**at your own risk!**) the WIP version that you can find at [this page](https://www.pyrevitlabs.io/)
+        ## 🚧 SentinelOne 🚧
+        If you have SentinelOne installed as an antivirus, **look no further**.
+        **You will need to create exceptions for Revit and pyRevit**, both on the software and the %appdata% folders. ask your IT guy to do that.
   - type: checkboxes
     id: preflight
     attributes:
       label: ✈ Pre-Flight checks
-      description: before submitting an issue, make sure you've checked the following
+      description: before submitting an issue, make sure you've checked the following.
       options:
         - label: I **don't have SentinelOne** antivirus installed (see above for the solution)
-          required: true
         - label: I have **searched in the issues** (open and closed) but couldn't find a similar issue
-          required: true
         - label: I have **searched in the [pyRevit Forum](https://discourse.pyrevitlabs.io)** for similar issues
-          required: true
         - label: I already **followed the [installation troubleshooting guide](https://pyrevitlabs.notion.site/Installation-issues-f6495adb56254e9e8021f8a68e3b2ab7) thoroughly**
-          required: true
         - label: I am using the **latest pyRevit Version**
-          required: true
   - type: textarea
     id: description
     attributes:
       label: 🐞 Describe the bug
-      description: Be as specific as possible and list steps to reproduce the issue.
+      description: Be **as specific as possible**. see "how to ask questions the smart way" above
     validations:
       required: true
   - type: textarea
     id: error-message
     attributes:
       label: ⌨ Error/Debug Message
-      description: If you have any suggestions for the solution, please list that as well. Issues related to tools/scripts, I tried to run them in debug mode (CTRL+click on the button) and copy over the contents of the output window.
+      description: |
+        Post the text (preferred) or screenshot of the error, if any.
+        For issues related to tools/scripts, run them in debug mode (CTRL+click on the button) and copy over the contents of the output window (use the copy button in the title bar and paste it here).
       render: shell
     validations:
       required: true
   - type: textarea
     id: reproduce-steps
     attributes:
       label: ♻️ To Reproduce
-      description: Steps to reproduce the behavior
+      description: Steps to reproduce the behavior. Tell us exactly what you did so that we can try to reproduce on our own computers.
       placeholder: |
         1. Go to '...'
         2. Click on '....'
-        3. Scroll down to '....'
-        4. See error
+        3. Select '....'
+        4. Type '...'
+        5. See error
   - type: textarea
     id: expected-behavior
     attributes:
@@ -59,12 +64,15 @@ body:
     id: env
     attributes:
       label: 🖥️ Hardware and Software Setup (please complete the following information)
-      description: Open a command prompt 🖥 and run the command `pyrevit env`. Paste the output here.
+      description: |
+        Open a command prompt 🖥 and run the command `pyrevit env`. Paste the output here. 
+        **This is super important for us to know if there's something wrong/specific in your setup!**
+        Not filling this may result in the issue to be closed without explanation.
       render: shell
     validations:
       required: true
   - type: textarea
     id: context
     attributes:
       label: Additional context
-      description: Add any other context about the problem here.
+      description: Add any other context about the problem here. If you have any suggestions for the solution, please list that as well. 

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+
+# Name of your PR
+
+## Description
+
+Please provide a brief description of the changes introduced in this pull request. Explain the purpose of these changes and their intended effect on the project.
+
+---
+
+## Checklist
+
+Before submitting your pull request, ensure the following requirements are met:
+
+- [ ] Code follows the [PEP 8](https://peps.python.org/pep-0008/) style guide.
+- [ ] Code has been formatted with [Black](https://github.com/psf/black) using the command:
+  ```bash
+  pipenv run black {source_file_or_directory}
+  ```
+- [ ] Changes are tested and verified to work as expected.
+
+---
+
+## Related Issues
+
+If applicable, link the issues resolved by this pull request:
+
+- Resolves #[issue number]
+
+---
+
+## Additional Notes
+
+Include any additional context, screenshots, or considerations for reviewers.
+
+---
+
+Thank you for contributing to pyRevit! 🎉

.github/dependabot.yml

@@ -7,16 +7,18 @@ updates:
       # Check for npm updates on Sundays
       day: "sunday"
     # Raise pull requests for version updates
-    # to pip against the `develop-4` branch
-    target-branch: "develop-4"
+    # to pip against the `develop` branch
+    target-branch: "develop"
   - package-ecosystem: "gomod"
     # directory required https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#vendor
     directory: "/"
-    target-branch: "develop-4"
+    target-branch: "develop"
     schedule:
       interval: "monthly"
     # Set update schedule for GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
+      # Check for updates to GitHub Actions every week
+      interval: "monthly"
+    target-branch: "develop"

.github/workflows/docs.yml

@@ -35,6 +35,6 @@ jobs:
       - name: Prepare pipenv
         run: |
           pip install pipenv
-          pipenv install
+          pipenv sync
 
       - run: pipenv run mkdocs gh-deploy --force

.github/workflows/main.yml

@@ -3,14 +3,14 @@ on:
   # when PRs from forked repos are merged
   push:
     branches:
-      - develop-4
-=========
-  # eirannejad 02/12/2024: disabled develop ci/cd builds for pyRevit 5
-  # we will reactivate when changes are ready to build on every commit
-  # push:
-    # branches:
-    #   - develop
->>>>>>>>> Temporary merge branch 2
+      - develop
+    paths:
+      - 'bin/**'
+      - 'dev/**'
+      - 'extensions/**'
+      - 'pyrevitlib/**'
+      - 'release/**'
+      - 'site-packages/**'
   # when PR from develop->master is created
   pull_request:
     branches:
@@ -31,7 +31,6 @@ env:
 
 jobs:
   build:
-    if: github.repository == 'eirannejad/pyRevit'
     runs-on: windows-latest
     steps:
       - name: Report Context
@@ -50,10 +49,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          ref: ${{ github.head_ref }}
-
-      - name: Checkout Submodules
-        uses: snickerbockers/submodules-init@7ce9774442c0c2d4728e6d3f66141df2102e4cbc
+          submodules: recursive
 
       - name: Prepare Python 3.10
         uses: actions/setup-python@v5
@@ -92,15 +88,15 @@ jobs:
         run: |
           pipenv run pyrevit set year
 
-      - name: Update Certificate
-        if: (github.repository == env.MainRepo)
-        env:
-          CERTIFICATE: ${{ secrets.CERTIFICATE }}
-          CERTIFICATEPASSWORD: ${{ secrets.PASSWORD }}
-          CERTIFICATESHA1: "${{ secrets.CERTIFICATESHA1 }}"
-          CERTIFICATENAME: "${{ secrets.CERTIFICATENAME }}"
-        run: |
-          pipenv run pyrevit sign addcert
+      # - name: Update Certificate
+      #   if: (github.repository == env.MainRepo)
+      #   env:
+      #     CERTIFICATE: ${{ secrets.CERTIFICATE }}
+      #     CERTIFICATEPASSWORD: ${{ secrets.PASSWORD }}
+      #     CERTIFICATESHA1: "${{ secrets.CERTIFICATESHA1 }}"
+      #     CERTIFICATENAME: "${{ secrets.CERTIFICATENAME }}"
+      #   run: |
+      #     pipenv run pyrevit sign addcert
 
       # WIP only
       - name: Update Build Info (WIP)
@@ -136,32 +132,69 @@ jobs:
         with:
           path: release/version
 
-      - name: Sign Products
+      # - name: Sign Products
+      #   if: (github.repository == env.MainRepo)
+      #   env:
+      #     CERTIFICATE: ${{ secrets.CERTIFICATE }}
+      #     CERTIFICATEPASSWORD: ${{ secrets.PASSWORD }}
+      #     CERTIFICATESHA1: "${{ secrets.CERTIFICATESHA1 }}"
+      #     CERTIFICATENAME: "${{ secrets.CERTIFICATENAME }}"
+      #   run: |
+      #     pipenv run pyrevit sign products
+
+      # - name: Sign Installers
+      #   if: (github.repository == env.MainRepo)
+      #   env:
+      #     CERTIFICATE: ${{ secrets.CERTIFICATE }}
+      #     CERTIFICATEPASSWORD: ${{ secrets.PASSWORD }}
+      #     CERTIFICATESHA1: "${{ secrets.CERTIFICATESHA1 }}"
+      #     CERTIFICATENAME: "${{ secrets.CERTIFICATENAME }}"
+      #   run: |
+      #     pipenv run pyrevit sign installers
+
+      # default retention period is 90 days
+      # https://github.com/marketplace/actions/upload-a-build-artifact#retention-period
+
+      - name: Sign files with Trusted Signing (DLLs and EXEs)
         if: (github.repository == env.MainRepo)
-        env:
-          CERTIFICATE: ${{ secrets.CERTIFICATE }}
-          CERTIFICATEPASSWORD: ${{ secrets.PASSWORD }}
-          CERTIFICATESHA1: "${{ secrets.CERTIFICATESHA1 }}"
-          CERTIFICATENAME: "${{ secrets.CERTIFICATENAME }}"
-        run: |
-          pipenv run pyrevit sign products
+        uses: azure/trusted-signing-action@v0.5.1
+        with:
+          azure-tenant-id: ${{ secrets.AZURE_TENANT_ID }}
+          azure-client-id: ${{ secrets.AZURE_CLIENT_ID }}
+          azure-client-secret: ${{ secrets.AZURE_CLIENT_SECRET }}
+          endpoint: ${{ secrets.AZURE_ENDPOINT }}
+          trusted-signing-account-name: ${{ secrets.AZURE_CODE_SIGNING_NAME }}
+          certificate-profile-name: ${{ secrets.AZURE_CERT_PROFILE_NAME }}
 
+          files-folder: bin/
+          files-folder-filter: pyrevit*.exe,pyrevit*.dll
+          files-folder-recurse: true
+          file-digest: SHA256
+          timestamp-rfc3161: http://timestamp.acs.microsoft.com
+          timestamp-digest: SHA256
+
       - name: Build Installers
         run: |
           pipenv run pyrevit build installers
 
-      - name: Sign Installers
+      - name: Sign files with Trusted Signing (installers)
         if: (github.repository == env.MainRepo)
-        env:
-          CERTIFICATE: ${{ secrets.CERTIFICATE }}
-          CERTIFICATEPASSWORD: ${{ secrets.PASSWORD }}
-          CERTIFICATESHA1: "${{ secrets.CERTIFICATESHA1 }}"
-          CERTIFICATENAME: "${{ secrets.CERTIFICATENAME }}"
-        run: |
-          pipenv run pyrevit sign installers
+        uses: azure/trusted-signing-action@v0.5.1
+        with:
+          azure-tenant-id: ${{ secrets.AZURE_TENANT_ID }}
+          azure-client-id: ${{ secrets.AZURE_CLIENT_ID }}
+          azure-client-secret: ${{ secrets.AZURE_CLIENT_SECRET }}
+          endpoint: ${{ secrets.AZURE_ENDPOINT }}
+          trusted-signing-account-name: ${{ secrets.AZURE_CODE_SIGNING_NAME }}
+          certificate-profile-name: ${{ secrets.AZURE_CERT_PROFILE_NAME }}
 
-      # default retention period is 90 days
-      # https://github.com/marketplace/actions/upload-a-build-artifact#retention-period
+          # Sign all exes inside the folder
+          files-folder: dist/
+          files-folder-filter: exe,msi
+          file-digest: SHA256
+          timestamp-rfc3161: http://timestamp.acs.microsoft.com
+          timestamp-digest: SHA256
+
       - name: Upload Installers
         uses: actions/upload-artifact@v4
         with:
@@ -190,8 +223,8 @@ jobs:
 
       - name: Publish Release (Release)
         id: publish_release
-        if: (github.base_ref == env.ReleaseBranch)
-        uses: softprops/action-gh-release@v1
+        if: (github.base_ref == env.ReleaseBranch && github.repository == env.MainRepo)
+        uses: softprops/action-gh-release@v2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.gitignore

@@ -11,13 +11,13 @@ extensions/*
 !extensions/extensions.json
 !extensions/README.md
 !extensions/pyRevitBundlesCreatorExtension.extension/
-bin/*
-!bin/engines
-!bin/pyrevit.svg
-!bin/pyrevit_outputwindow.png
-!bin/pyrevit_settings.png
-!bin/pyrevit-hosts.json
-!bin/pyrevit-products.json
+#bin/*
+#!bin/engines
+#!bin/pyrevit.svg
+#!bin/pyrevit_outputwindow.png
+#!bin/pyrevit_settings.png
+#!bin/pyrevit-hosts.json
+#!bin/pyrevit-products.json
 
 # ignore visual studio files
 **/.vs
@@ -60,3 +60,8 @@ dist/
 .idea
 site/
 *.pdb
+*.deps.json
+bin/**/*.xml
+*.so
+*.a
+*.dylib

.pyrevitargs

@@ -0,0 +1,3 @@
+https://github.com/pyrevitlabs/pyRevit/archive/master.zip
+master
+basepublic

.vscode/settings.json

@@ -1,18 +1,4 @@
 {
-    "python.linting.pylintEnabled": false,
-    "python.linting.pylintArgs": ["--max-line-length=80"],
-    "python.linting.pylintUseMinimalCheckers": false,
-    "python.linting.pycodestyleEnabled": false,
-    "python.linting.flake8Enabled": true,
-    "python.linting.pylamaEnabled": false,
-    "python.linting.mypyEnabled": false,
-    "python.jediEnabled": true,
-    "restructuredtext.confPath": "${workspaceFolder}/docs",
-    "python.formatting.provider": "autopep8",
-    "python.languageServer": "Jedi",
-    "python.formatting.blackArgs": [
-        "--line-length=80"
-    ],
     "editor.formatOnSave": false,
     "files.exclude": {
         "**/.git": true,
@@ -29,6 +15,4 @@
         "**/__pycache__": true,
         "**/Prerequisites": true,
     },
-    "python.pythonPath": "C:\\Users\\ehsan\\.virtualenvs\\pyrevit-dev-2PO7Kqjk\\Scripts\\python.exe",
-    "python.linting.enabled": true
 }