Tools

• Resolved Issue (#1240: Isolate "Is Painted" error)
• Resolved Issue (#1224: Create Pattern not working in Revit 2022?)

Installer

• Resolved Issue (#1228: Installing pyRevit 4.8.7 as admin sets environment variables as user instead of system)
• Resolved Issue (#1237: BasePublic Deployment fails to install - 'extensions/pyRevitRun.run' missing from repository)

Telemetry

• Attempt at Resolving Issue (#1225 Telemetry not writing host_user randomly)

API

• Resolved Issue (#1242: Fix config reading for switches in CommandSwitchWindow)
• Resolved Issue (#1221: allowdialogs fix)

Misc Changes

• Resolved Issue (#1231: Created new check modelchecker_Warnings_check.py)
• Resolved Issue (#1218: I translated in french the sum total button as an example)

Command Line Utility

• Resolved Issue (#1220: Allow Dialogs in Journal Playback)

What's New

Changes to Runtime

pyRevit engines now manually load their own DLLs into Revit to ensure that pyRevit is running on its own engine assemblies. This resolved import wpf errors when another Revit addon would load IronPython 277 (e.g RevitPythonShell) before pyRevit loaded and it would cause a conflict. All engine versions were tested against Revit 2017-2021 and they all load

Minor changes have been added to fix wpf and sqlite3 imports under the new load mechanism.

Changes to pyRevit Installer

pyRevit installer now switched to Admin mode when ran "As Administrator" (privileged mode). So the new behavior is:

• When ran as a normal user, it defaults to %APPDATA%\pyRevit-Master for installation and attaches itself to installed Revits for current user only (%APPDATA%\Autodesk\Revit\Addins)

• When ran as a Admin in privileged mode, it defaults to %PROGRAMFILES%\pyRevit-Master for installation and attaches itself to installed Revits for all users (%PROGRAMDATA%\Autodesk\Revit\Addins)

Support for Dockable panels

Support for dockable panels were added to the forms module. The mechanism follows the Dockable panel design in Revit API. See this Extension startup script example that registers a dockable panel on Revit startup:

class DockableExample(forms.WPFPanel):
    panel_title = "pyRevit Dockable Panel Title"
    panel_id = "3110e336-f81c-4927-87da-4e0d30d4d64a"
    panel_source = op.join(op.dirname(__file__), "DockableExample.xaml")

    def do_something(self, sender, args):
        forms.alert("Voila!!!")


forms.register_dockable_panel(DockableExample)

and this pyRevit script that requests opening a previously registered panel

from pyrevit import forms
test_panel_uuid = "3110e336-f81c-4927-87da-4e0d30d4d64a"
forms.open_dockable_panel(test_panel_uuid)

Tools

• Resolved Issue (#1206: ASCII Keynote Conversion Failed)
• Resolved Issue (#1198: Hard crash Print Sheets tool Revit 2018)
• Resolved Issue (#1196: Issue with number of tab colors)
• Resolved Issue (#1202: Update Duplicate Views Dependent)
• Added reset colors option to Tab Coloring options

API

• Resolved Issue (#1204: Output Styling (CSS Stylesheet) path is empty by default and doesn't persist through Revit restart)
• Implemented dockable panel into forms module

Misc Changes

• Attempt at resolving config access error when multiple instances of Revit are executed together

• cli can now add the current clone previt clones add this <clone_name>
• pyrevit cli now knows when it is running in privileged mode and uses the admin settings under %PROGRAMDATA%\pyRevit

Happy Norooz! 🎈

New Tab Colorizer with Style Options

Read more here

New Context Conditions

Read more here

Tool context has been modified to include more options e.g. Document contexts doc-project, doc-workshared, doc-family and compound conditions with any, all, except, not_any, etc.

Tools

• Resolved Issue (#1173: New tool - close tabs)
• Resolved Issue (#1017: Print Sheets not included in schedule)
• Resolved Issue (#1082: PrintSheets;Beta5: Error when writing multiple sheets to single file)
• Resolved Issue (#1168: Re-Categorize Keynote)
• Resolved Issue (#1194: pyRevit Emoji not fonctionning)
• Resolved Issue (#1170: Print name issue)
• Resolved Issue (#1176: Pre Flight Check - Model Check "'Chart' is undefined")
• Resolved Issue (#1028: Error message on COPY/MOVE SELECTED VIEWPORTS TO SELECTED SHEETS)
• Resolved Issue (#1095: 'Remove Revision From Sheets' button should be 'UNset Revision')
• Resolved Issue (#1152: Keynote manager - BIM 360)
• Resolved Issue (#1156: Added UTF-8 encoding)
• Resolved Issue (#1162: Preflight checks: Rearranged the family collection part + added generic ...)
• Resolved Issue (#1183: Fix for issue #1182)
• Resolved Issue (#1179: Cleaning NPC before reapplying them)
• Fixed temporary file bug in keynote conversion

Runtime

• Resolved Issue (#1131: Update button hiding buttons)
• Resolved Issue (#1143: Keynote Manager setup issue BIM 360)
• Fixed bug on finding config file

Extension Hooks

• Resolved Issue (#1165: Document Data File in Hooks now using event Doc)

API

• Resolved Issue (#1195: add optional doc parameter to query functions)
• Added color picker (forms.ask_for_color())
• Added dockable panel example (pyRevitDev extension)

pyRevit CLI now supports using access tokens with the new --token= option on the command line
Misc bug fixes

New Features, Tools

• Preflight Checks: pyRevit Extensions can now include a checks/ directory with python scripts engine in *_check.py and implementing a Preflight Check type. These checks will automatically show up in the new Preflight Checks tool

  • PRs Merged #1103 #1135 #1129 #1125 #1123 #1014 #975

• Custom IronPython Engine: pyRevit now includes a custom IronPython engine. This engine is NOT the default for this release, so we have a chance to get it tested, but it will be the default soon. All previous engines are still supported. The custom engine provides a solution to all the IronPython conflicts and import wpf errors hopefully. To use this, go to pyRevit settings and switch the IronPython engine under Core Settings to this new custom engine, or use the pyRevit CLI to attach using this engine pyrevit attach master default --installed

• Added New doc-updater hook: This hook is executed every time a model is updated. See example here this example hook, automatically updates the height of new walls to 5 when they are created

• Added New Tool (#883: Tool to Clear BIM360 Collaboration Cache): Find under Wipe tools

• Added ReKey buttons to Keynote Manager (#701: Keynote Manager Needs Keynote-Edit-KEY Button): Both categories and keynotes can be rekeyed now

Breaking Changes

• There are no .run extensions anymore. Run script can now be included inside any extension under the commands/ directory and ending in *_command.py. pyRevit CLI when batch processing using pyrevit run can find these commands. See example here

Tools

• Resolved Issue (#1143: Keynote Manager setup issue BIM 360)
• Added grids and levels to ReNumber tool
• Fixed many keynote manager bugs
• Resolved Issue (#1140: Handled rvt links not loaded + not displyaing warnings section when no warning)
• Resolved Issue (#1077: Save Families fails to overwrite families)
• Resolved Issue (#1076: Parameter framework modification)
• Resolved Issue (#1117: Modification to Import/Export Family Configs)
• Fixed bad schedule export in 2021
• Updated the import export family config tools

Supported Revits

• Added Revit 2021.1.2

Framework Updates

• Resolved Issue (#1133: output: not able to save the js part of the output windows as html + js dependencies)

Telemetry

• Added hooks to the script telemetry system

Extensions

• added MEPDesign to extensions
• added pyStructure extension

API

• Fixed file info bug with newer Revit models

Other

If you are upgrading from pyRevit 4.7.* see these release notes as well:

• https://github.com/eirannejad/pyRevit/releases/tag/v4.8.4
• https://github.com/eirannejad/pyRevit/releases/tag/v4.8.3
• https://github.com/eirannejad/pyRevit/releases/tag/v4.8.2
• https://github.com/eirannejad/pyRevit/releases/tag/v4.8.1
• https://github.com/eirannejad/pyRevit/releases/tag/v4.8.0

• Fixed bug detaching all users
• Fixed file info bug with newer Revit models
• Resolved Issue (#1118: Unable to add URL as source for extensions)
• CLI doesn't crash anymore reading running Revit processes
• clone delete now detaches the existing first

Community!

pyRevit now has a discourse group

Tools

• Resolved Issue (#1061: Add folder window disappears in Custom Extension Directories )
• Resolved Issue (#1070: Add placeholder sheets back to Set/Remove revisions on sheets tool)
• Resolved Issue (#1069: List TitleBlocks on Sheets) - Combined Select TitleBlocks on Sheets into this tool
• Resolved Issue (#1063: Furniture tags)
• Resolved Issue (#1058: Add Favourite Categories to Isolate button)

Framework Updates

• Resolved Issue (#1071: Multi Group List fails)
• Resolved Issue (#1060: Sorting parameters by name in selector forms)

Installer

• Resolved Issue (#1007: pyRevit can not attach to a Revit that it does not know its build number)

Command Line Utility

• Fixed release checks

Misc Changes

• First draft of pyrevit doctor command

• CLI now finds Revit 2021 EXE although the registry key InstallPath is relative
• Fixed bugs with releases and version checker

Featured Changes

• First draft of bim360 sync with keynote manager (#795: Keynote Manager Compatibility with BIM360)
• New Load Families From Folder tool (Merged #1041: added Load Families.pushbutton)
• Added Revitron to list of default extensions

Next Release

• pyrevit doctor command line option to fix pyRevit installation issues
• Preflight Checks
• Fully tested BIM360 integration with Keynote Manager
• Keynote Manager Improvements (e.g Rekey Keynotes)

Tools

• Resolved Issue (#1044: SearchPrompt captures a return key stroke from previous dialog)
• Resolved Issue (#944: PyRevit Revalue Find and Replace Funcation)
• Resolved Issue (#992: Reload Links: "Can not aquire location")
• Resolved Issue (#994: Error on Memory > Previous)
• Resolved Issue (#1010: PyRevit-Find Range of Roof Slope Bug)
• Resolved Issue (#989: PyRevit-Colurized Groups Bugs)
• Resolved Issue (#993: List DWGs in Current View fails (NameError: global name 'author' is not defined))
• Resolved Issue (#989: PyRevit-Colurized Groups Bugs)
• Fixed a couple of bugs on sheet print settings setter

Installer

• Resolved Issue (#1030: Update clone from CLI fails)

Command Line Utility

• Resolved Issue (#1031: CLI env --json)
• Resolved Issue (#1030: Update clone from CLI fails)
• Resolved Issue (#1029: Clone Creation Error)
• Fixed fileinfo bad index bug

Telemetry

• Resolved Issue (#1034: Telemetry issue)

API

• Element links now have a separate link for "Select" and "Show"
  

Misc Changes

• Update README (#1004: Readme Updates)
• Added art images to the repo

Tools

• Keynote Manager bug fixes (fixed index error, better category selector, fixed indexing bug that could happen due to bad configs)
• Merged PR by @melnikovalex (#985: Extensions UI - Show extension from custom extension.json)
• Merged PR by @melnikovalex (#978: Improvements and fixes (Copy State, Fam.Sizes, Duplicate Views, Overkill etc.) )
• Resolved Issue (#859: Match Properties bug/unexpected behaviour)
• Resolved Issue (#968: Duplicate schedule name with import from CSV makes pyrevit error)
• Resolved Issue (#898: Make Pattern Error - Revit 2020)

Runtime:

• added support for clr debug (video tutorial coming soon)

API

• improved unique value getter form

Misc improvements

New Features

• Output window now supports input. You can now take input from users using raw_input (IronPython 2.x) and input (cpython 3.x) It also works in C# and VB.Net using Console.ReadLine()

• Output window now supports pdb debugger

Tools

• Resolved Issue (#968: Duplicate schedule name with import from CSV makes pyrevit error)
• Resolved Issue (#629: Move Selected Viewports to Selected Sheet)
• Resolved Issue (#976: PyRevit Isolate missing some Revit items in view )
• Resolved Issue (#962: Print Sheets Does Not Remove Non-Printable Characters in v4.8.0)
• Resolved Issue (#571: PyRevit ReOrder Sheet Error)
• Resolved Issue (#970: Rename Sheets - Camelcase and remove spaces)
• Resolved Issue (#977: Colorize group types fixes)

Runtime

• Resolved Issue (#966: Install Error - eirannejad/pyRevit)

Misc Changes

• All emojies are stored in a resource dll called pyRevitLabs.Emojis.dll now. No more 2800 png files in the bin/emoji. This means easier installation
• All pyRevit dlls are signed now

Updates

Tools:

• Pick elements is now configurable. Shift-Click and select the favorites
• Print tool naming format now ensures templates end in .pdf (#767: Failure to Print to PDF) (#887: Print Sheets Revit 2021)
• ReValue tool now supports Find/Replace (#944: PyRevit Revalue Find and Replace Function)
• Misc fixes:
  • #892: Family config export shows integers as "false"
  • #913: Config window of Match function is too small
  • #934: Fix paste orientation between 3d Views
  • #954: Make Pattern Bottom button off screen
  • #927: Sync Views bugfix, Copy State improvements
  • #918: feat: add title to file pickers
  • #897: Sync Views Not Working pyRevit v4.7.6
  • #894: "Select Similar in a view" tool - use quick filter, allow to select in whole doc
  • #866: Revit 2020 'Create Modifier Filters'
  • #888: add Revit 2020.2.1 (New Install) build number
  • #885: cannot add extensions (previous failed cli installation)

Framework Updates

• Removed dependency on .Net Core
• Upgraded .Net Framework to v4.8
• Switched to using the same version for cli (last version was 0.25 and now is 4.8 matching pyRevit itself)

Engines

• Now using the modern C# compiler Roslyn. pyRevit runtime now compiles itself on this new compiler, and all the pyRevit C# bundles can now use the C# v8 version of the language (previously the max version was v5). An example of a new language feature is the interpolated strings e.g. $"UserName={username}" or lambda methods e.g. void GetResponse() => 42;
• IronPython 2.7.10 has been added to the list of runtime engines
• CPython engines updated to 3.8.5 and 3.7.8
• CPython 3.6.* was removed since the embedded binaries are not provided by python.org anymore

Supported Revits

• Adding support for Revit 2021 and dropping 2016

Installer

• Installer not longer uses PowerShell scripts internally (#936: Installer fails if PowerShell script execution is restricted by Group Policy)

Script bundles

• Bundles now support a help file (#941: Automatic detection of help files)

Telemetry

• Telemetry does not fail validation on Revit 2021 build number anymore
• Fixed issue with missing ending forward slash on telemetry urls is Settings window

API

• Updated rjm module to 1.4
• Other misc updates

CLI version now matches the pyRevit version. Last CLI version was 0.25 and this one is 4.8. This makes it easier for me to detect pyRevit versions from env reports. It was also confusing for the users why there are two version numbers associated with pyRevit and the CLI. This makes updating the cli a bit harder since it needs to match pyRevit version but CLI gets updated less that pyRevit itself usually.

Improvements

• Added Support for Revit 2021
• New pyRevit Routes HTTP API Micro-Framework.
  • See Documentation
  • See Intro Video
• rsparam updated to 0.1.15

Misc

• Resolved Issues #768 #781 #759 #665 #853 #690 #760 #812 #703 #656 #861 #871 #880
• Merged PR #769 #763 #875

• Resolved issue #760
• Clone from image no longer fails if can not delete staging dir
• Misc cleanups