[![GitHub issues](https://img.shields.io/github/issues/eirannejad/pyRevit.svg?style=for-the-badge)](https://github.com/eirannejad/pyRevit/issues) [![GitHub forks](https://img.shields.io/github/forks/eirannejad/pyRevit.svg?style=for-the-badge)](https://github.com/eirannejad/pyRevit/network) [![GitHub stars](https://img.shields.io/github/stars/eirannejad/pyRevit.svg?style=for-the-badge&colorB=red)](https://github.com/eirannejad/pyRevit/stargazers) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg?style=for-the-badge)](http://www.gnu.org/licenses/gpl-3.0) [![made with love in portland](https://img.shields.io/badge/%3C%2F%3E%20with%20%3C3-Portland%2C%20OR-green.svg?style=for-the-badge)](https://en.wikipedia.org/wiki/Portland,_Oregon)   pyRevit helps you quickly sketch out your automation and addon ideas, in whichever language that you are most comfortable with, inside the Revit environment and using its APIs. It also ships with an extensive set of powerful tools that showcase its capabilities as a development environment. Download and install pyRevit, launch Revit, and note the new pyRevit tab that includes these tools. pyRevit also ships with a handy CLI utility for customized configuration and deployment of your tools, and a telemetry server to monitor pyRevit usage across your teams.   ### pyRevit can help you - Add a **powerful set of free tools to your Revit workflows**. - **Sketch out** your automation **ideas quickly** in python - **Write your own Revit addons** for Revit using python ([IronPython](https://ironpython.net/) or [CPython](https://www.python.org/)), C#, VB.Net - **Distribute your tools** (pyRevit, [Dynamo](https://dynamobim.org/), or [Grasshopper](https://www.rhino3d.com/inside)) easily to your teams using a unified interface - **Share your tools** with the community   # Getting Started ## Get Started Using pyRevit [Install pyRevit](https://www.notion.so/Install-pyRevit-98ca4359920a42c3af5c12a7c99a196d) [Create Custom Patterns](https://www.notion.so/Create-Custom-Patterns-6b8db11b87ed49d98144b75407685152) [Manage Keynotes](https://www.notion.so/Manage-Keynotes-6f083d6f66fe43d68dc5d5407c8e19da) [Configure pyRevit](https://www.notion.so/Configure-pyRevit-461d8f564ba743d0ad7e843a7b3b2afe) [Install Extensions](https://www.notion.so/Install-Extensions-0753ab78c0ce46149f962acc50892491) **↓** More guides are available here [HOW TO Guides](https://www.notion.so/HOW-TO-Guides-dc20e0e227b74d9bbc775699904152cb) ## Get Started Developing for pyRevit [Create Your First Command](https://www.notion.so/Create-Your-First-Command-2509b43e28bd498fba937f5c1be7f485) **↓** Read the pyRevit API reference to know everything about pyRevit available modules, functions, ... [pyRevit API Reference](https://ein.sh/pyRevit/reference/pyrevit/) **↓** Read the docs to know everything about pyRevit scripts, extensions, ... [Developer Docs](https://www.notion.so/Developer-Docs-2c88f3ecccde422d9504e20b6b9e04f8) **↓** pyRevit has a powerful command line utility [pyRevit CLI](https://www.notion.so/pyRevit-CLI-c50de95259114db795db5bd3f19f8e2a) **↓** And when you are ready to deploy your tools to your team [pyRevit For Teams](https://www.notion.so/pyRevit-For-Teams-ddc6c312d6f6488691eed2ec7704fd97)   # Staying Updated Follow [pyRevit on Twitter](https://twitter.com/pyrevit) to stay notified about the upcoming changes and follow [pyRevit Release Notes](https://github.com/eirannejad/pyRevit/releases) for the breaking changes **↓** Check out the blog for news [Blog](https://www.notion.so/Blog-5bcadb69d8ab43c8ba5ee547e42a129f) **↓** And the future plans for pyRevit are laid out here [Roadmap](https://www.notion.so/Roadmap-8f353f66ffe94a5ea6676f0d3c5df5bd)   # Dealing with Issues Check the list of [Currently Open](https://github.com/eirannejad/pyRevit/issues) and [Previously Reported Issues](https://github.com/eirannejad/pyRevit/issues?q=is%3Aissue+is%3Aclosed) for anything similar to yours. **↓** See the FAQ page for questions [FAQs](https://www.notion.so/FAQs-70774c29e0ed41388f9a7857bc2e24dc) **↓** See the guide below on how to report new issues [Reporting New Issues](https://www.notion.so/Reporting-New-Issues-f1fdd62cf6074b318bfe8ddfbc2d8d98)   # Getting Involved **↓** Get involved with the community of developers, creating tools with and for pyRevit [Community](https://www.notion.so/Community-eb501192c78c4d2f884f0cc34532058e) ## Share Your Passion **↓** Help making pyRevit better [Help with Documentation](https://www.notion.so/Help-with-Documentation-3ad04b6431a046a3bc9ca584eeea51fa) [Help Translate pyRevit](https://www.notion.so/Help-Translate-pyRevit-c26063a6c9824667a07c6a40b28c70d4) [Create Tutorials](https://www.notion.so/Create-Tutorials-d25685ddb11d4eb6a76001325715cfb5) [Share Revit Build Numbers](https://www.notion.so/Share-Revit-Build-Numbers-90817d95875c48d0accb802035bfcb68) ## Share Your Code **↓** Help making pyRevit core and tools better [Improve pyRevit Core](https://www.notion.so/Improve-pyRevit-Core-109f014ece0043ed8e523605312b1305) [Contribute New Tools](https://www.notion.so/Contribute-New-Tools-800ecc0cee8e47b484f22359c4fe4307) [Share Your Extensions](https://www.notion.so/Share-Your-Extensions-48ff84d4eae846f4aa9567fca32ff4fe) [Bundle Shelf](https://www.notion.so/Bundle-Shelf-d1b57b18fd33426aa77d29de2e8b6cf7) ## Share Your Coins **↓** Help making pyRevit financially stronger [Support on Patreon](https://www.notion.so/Support-on-Patreon-cdf92ba547154f7a85d32b526dc5e59b) [Supporters](https://www.notion.so/Supporters-4f3350243ba24dcd8228df6262723629) # Contributors Made with [contrib.rocks](https://contrib.rocks)   --- **** with 🖤 in [Portland](https://en.m.wikipedia.org/wiki/Portland,_Oregon), Oregon Copyright © 2014-2024 by Ehsan Iran-Nejad (pyrevitlabs.io) - All Rights Reserved No part of this publication may be reproduced, distributed, or transmitted in any form or by any means, including photocopying, recording, or other electronic or mechanical methods, without the prior written permission of the publisher.