Merge pull request #2133 from eirannejad/develop-4

[DOCS] pyrevit modules and dependencies updates

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -1,49 +1,59 @@
 ---
 name: Bug report
 about: Create a report to help us improve
+labels: Bug
 
 ---
----
-
-**🚧 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.**
 
----
+> **🚧 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 use the search in the issue section before filing a new issue**
+# ✈ Pre-Flight checks
 
----
+- [ ] I **don't have SentinelOne** antivirus installed (see above for the solution)
+- [ ] I have **searched in the issues** (open and closed) but couldn't find a similar issue
+- [ ] I have **searched in the [pyRevit Forum](https://discourse.pyrevitlabs.io)** for similar issues
+- [ ] I already **followed the [installation troubleshooting guide](https://pyrevitlabs.notion.site/Installation-issues-f6495adb56254e9e8021f8a68e3b2ab7) thoroughly**
+- [ ] I am using the **latest pyRevit Version**
 
 # 🐞 Describe the bug
 
-Replace these lines with your description. Be as specific as possible and list steps to reproduce the issue. If you have any suggestions for the solution please list that as well.
-
-If you have installed pyRevit, and the installation completed with no errors but pyRevit doesn't load, please run the command below in terminal / command line. This should fix the issue on your machine, however, please continue filing the issue with instructions below.
-
-👉 `pyrevit attach master 2711 --installed`
-
-If it does not work, try to disable your revit addins, all of them. Then, one at a time, reactivate them and restart Revit to figure out which one is interacting badly with pyRevit and Report.
-
+<!-- Replace these lines with your description.
+Be as specific as possible and list steps to reproduce the issue. 
+If you have any suggestions for the solution, please list that as well.
+-->
 
 # ♻️ To Reproduce
+
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
 # ⏲️ Expected behavior
-A clear and concise description of what you expected to happen.
+
+<!-- A clear and concise description of what you expected to happen. -->
 
 # 🖼 Screenshots of the issue
-If applicable, add screenshots to help explain your problem.
 
-# 🖥️ Hardware and Software Setup (please complete the following information):
- - OS: [e.g. iOS]
- - pyRevit Version [e.g. 22]
- - pyRevit Environment: Open a command prompt 🖥 and run the command below. Replace these lines with the results. Take a look at this markdown guide and wrap the command results in ``` when pasting here for correct formatting.
+<!-- If applicable, add screenshots to help explain your problem. 
+You can use a tool like the free ScreenToGif to create a GIF of the actions you perform. -->
+
+# 🖥️ Hardware and Software Setup (please complete the following information)
+
+- Windows version [e.g. 10 or 11]
+- pyRevit Version [e.g. 22]
+- pyRevit Environment:
+
+<!-- Open a command prompt 🖥 and run the command `pyrevit env`. 
+Paste the output inside the ``` below. -->
+
+```
 
-👉 `pyrevit env`
+```
 
 # Additional context
-Add any other context about the problem here.
 
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -1,17 +1,21 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-
+labels: "New Feature"
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+## Is your feature request related to a problem? Please describe
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when... -->
+
+## Describe the solution you'd like
+
+<!-- A clear and concise description of what you want to happen. -->
+
+## Describe alternatives you've considered
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+## Additional context
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+<!-- Add any other context or screenshots about the feature request here. -->

.github/workflows/main.yml

@@ -3,7 +3,7 @@ on:
   # when PRs from forked repos are merged
   push:
     branches:
-      - develop
+      - develop-4
   # when PR from develop->master is created
   pull_request:
     branches:
@@ -16,6 +16,7 @@ env:
 
 jobs:
   build:
+    if: github.repository == 'eirannejad/pyRevit'
     runs-on: windows-latest
     steps:
       - name: Report Context
@@ -31,7 +32,7 @@ jobs:
           echo "commit: ${{ github.sha }}"
 
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{ github.head_ref }}
@@ -53,7 +54,7 @@ jobs:
         uses: microsoft/[email protected]
 
       - name: Prepare git
-        uses: fregante/setup-git-user@v1
+        uses: fregante/setup-git-user@v2
 
       - name: Check Build Environment
         run: pipenv run pyrevit check

.gitignore

@@ -11,6 +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
 
 # ignore visual studio files
 **/.vs

.gitmodules

@@ -13,3 +13,15 @@
 [submodule "dev/modules/pyRevitLabs.ironpython3"]
 	path = dev/modules/pyRevitLabs.ironpython3
 	url = https://github.com/pyrevitlabs/ironpython3.git
+[submodule "dev/modules/pyRevitLabs.MahApps.Metro"]
+	path = dev/modules/pyRevitLabs.MahApps.Metro
+	url = https://github.com/pyrevitlabs/MahApps.Metro.git
+	branch = pyrevit-main
+[submodule "dev/modules/pyRevitLabs.NLog"]
+	path = dev/modules/pyRevitLabs.NLog
+	url = https://github.com/pyrevitlabs/NLog.git
+	branch = pyrevit-main
+[submodule "dev/modules/pyRevitLabs.Newtonsoft.Json"]
+	path = dev/modules/pyRevitLabs.Newtonsoft.Json
+	url = https://github.com/pyrevitlabs/Newtonsoft.Json.git
+	branch = pyrevit-main

Pipfile

@@ -5,7 +5,7 @@ verify_ssl = true
 
 [dev-packages]
 mypy = "*"
-pylint = "==2.17.5"
+pylint = "==3.1.0"
 black = "*"
 
 [packages]
@@ -14,7 +14,7 @@ requests = "*"
 pygount = "*"
 pyyaml = ">=5.4"
 black = "*"
-setuptools = "==65.5.1"
+setuptools = "==69.1.1"
 mkdocs = "*"
 mkdocstrings = "*"
 mkdocstrings-python = "*"