https://github.com/revitron/revitron

A python wrapper for the Revit API to be used as a pyRevit extension
https://github.com/revitron/revitron

pyrevit pyrevit-extensions python-wrapper revit revit-addin revit-api revitron

Last synced: 2 months ago
JSON representation

A python wrapper for the Revit API to be used as a pyRevit extension

• Host: GitHub
• URL: https://github.com/revitron/revitron
• Owner: revitron
• License: mit
• Created: 2020-05-16T15:34:47.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-20T14:42:03.000Z (about 3 years ago)
• Last Synced: 2024-05-02T02:32:40.549Z (almost 2 years ago)
• Topics: pyrevit, pyrevit-extensions, python-wrapper, revit, revit-addin, revit-api, revitron
• Language: Python
• Homepage: https://revitron.readthedocs.io
• Size: 475 KB
• Stars: 58
• Watchers: 5
• Forks: 11
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
![](https://raw.githubusercontent.com/revitron/revitron/master/svg/revitron-readme.svg)

# Revitron

Revitron is a [Revit API](https://www.revitapidocs.com/) wrapper written in Python. It helps you to develop clean and powerful Revit plugins for [pyRevit](https://github.com/eirannejad/pyRevit). 

![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/revitron/revitron?label=version&color=222222)

![GitHub](https://img.shields.io/github/license/revitron/revitron?color=222222)

![GitHub top language](https://img.shields.io/github/languages/top/revitron/revitron?color=222222)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/revitron/revitron?color=222222)

![Read the Docs](https://img.shields.io/readthedocs/revitron?color=222222)

![](https://img.shields.io/badge/Revit-2019--2023-222222)

- [Installation](#installation)

	- [Using the pyRevit UI](#using-the-pyrevit-ui)

	- [Using the pyRevit CLI](#using-the-pyrevit-cli)

	- [Bundled Version](#bundled-version)

- [Revitron CLI Setup](#revitron-cli-setup)

- [Documentation](#documentation)

## Installation

There are three options for installing Revitron and the [Revitron UI](https://revitron-ui.readthedocs.io/) — using the [pyRevit UI](#using-the-pyrevit-ui), using the [pyRevit CLI](#using-the-pyrevit-cli) or installing the [full bundle](#bundled-version).

> ☝ Note that in order to use the Revitron package manager or the bundle installer, [Git](https://git-scm.com/) must be installed on your computer.

### Using the pyRevit UI

To use the *Revit UI* to install this extensions, open the *pyRevit* tab, click on *pyRevit > Extensions* to open the extensions manager and follow [these](https://www.notion.so/Install-Extensions-0753ab78c0ce46149f962acc50892491) instructions.

### Using the pyRevit CLI

In case you want to use the command line to install *Revitron* and the *Revitron UI*, use the following command:

	pyrevit extend lib revitron https://github.com/revitron/revitron.git

	pyrevit extend ui revitron https://github.com/revitron/revitron-ui.git

### Bundled Version

There is also a bundle installer available that will install *pyRevit* including the *Revitron* and the *Revitron UI* packages.

1. Right-click [here](https://raw.githubusercontent.com/revitron/installer/master/install.bat) to download the installer. Make sure it keeps the `.bat` extension.

2. Move the `install.bat` to the directory, where you want to install *pyRevit*.

3. Double-click the `install.bat` file.

4. Start *Revit*.

## Revitron CLI Setup

In order to use the `revitron` command on the Windows CLI, its location has to be added to the environment as follows:

	cd path\to\revitron.lib

	cli\setup

Now you can use the `revitron` everywhere on the system.

## Documentation

The full documentation and API reference as well as some cheat sheets can be found [here](https://revitron.readthedocs.io/).

---

© 2020-2022 [Marc Anton Dahmen](https://marcdahmen.de) — MIT license