aps-toolkit

aps-toolkit copied to clipboard

🔩 APS Toolkit

APS Toolkit (Former is Forge) is powerful tool for developer,software enginner, AI engineer to explore Autodesk Platform Services(APS). It's built on top of Autodesk.Forge and Newtonsoft.Json. Forge Toolkit includes some features allow you to read, download and write data from Autodesk Platform Services and export to CSV, Excel, JSON, XML, etc.

⚡ Features

• [x] Read/Download SVF Model
• [x] Read/Query Properties Database SQLite
• [x] Read/Download Properties Without Viewer
• [x] Read Geometry Data
• [x] Read Metadata
• [x] Read Fragments
• [x] Read MeshPacks
• [x] Read Images
• [x] Export Data to CSV
• [x] Export Data to Excel
• [x] Export Data to Parquet

⚙ Installation

.NET

Please follow latest update at APSToolkit Nuget

<PackageReference Include="APSToolkit" Version="1.*" />

Python

Please follow latest update at APSToolkit Python

pip install aps-toolkit --upgrade

Before start you need setup your environment:

APS_CLIENT_ID = <your client id>
APS_CLIENT_SECRET = <your client secret>
APS_REFRESH_TOKEN = <your refresh token>

⭐ Getting Started

I want export Revit Data To Excel 👇

.NET

using APSToolkit;
using Autodesk.Forge;
using APSToolkit.Database;
using APSToolkit.Auth;
var token = Authentication.Get2LeggedToken().Result;
string urn = "<Derivative URN>";
var RevitPropDbReader = new PropDbReaderRevit(urn, token);
RevitPropDbReader.ExportAllDataToExcel("result.xlsx");

Python

from aps_toolkit import Auth
from aps_toolkit import PropDbReaderRevit
auth = Auth()
token = auth.auth2leg()
urn = "<Derivative URN>"
prop_reader = PropDbReaderRevit(urn, token)
df = prop_reader.get_data_by_category("Ducts")
df.save_to_excel("result.xlsx")

📚 Tutorials

.NET

All Tutorials are available under Jupyter Notebook at .NET Tutorials

• 00. Jupyter Notebook And .NET Interactive
• 01. Setup And Authentication
• 02. Explore Hubs - Projects - Items - URN
• 03. Explore Versions Item and Derivative Urn
• 04. Explore General Metdadata With APSToolkit
• 04.01. Explore Revit Data With APSToolkit
• 05. Explore Access APS Database And Execute Query
• 06. Explore SVF Format - Export SVF Viewer
• 07. Explore Update Revit Data Back To ACC
• 08. Explore Pull Data From ACC BIM360 API
• 09. Explore Data Knowledge Use LLM Agent
• 10. Build Pipeline Data Process with APSToolkit
• 11. Visualization Data - Data Analyst
• 12. Custom Python In .NET Interactive
• 13. Custom Metadata Export

Python

All Tutorials are available under Jupyter Notebook at Python Tutorials

• 00. Jupyter Notebook And Python
  • 00.01. Jupyter Notebook And Google Colab
• 01. Setup And Authentication
• 02. Explore Hubs - Projects - Items - URN
• 03. Explore Versions Item and Derivative Urn
• 04. Explore General Metdadata With APSToolkit
  • 04.01. Explore Revit Data With APSToolkit
  • 04.02. Explore Compare Revit Data Versions
  • 04.03. Explore Acad Data With APSToolkit
  • 04.04. Explore Navisworks Data With APSToolkit
• 05. Explore Access Database And Query Items
• 06. Data Visualization - Analyst BIM Model
• 07. Explore Big Data Format Storage
• 08. Explore URL ACC Extract
• 09. Explore SVF - Export SVF Viewer

License

Many source codes here are collected from open-source authors under the MIT License. Without their sharing and contributions, I wouldn't be able to do this. I am deeply grateful to them, and therefore, I hope that if you are using this tool, please thank them before thanking me and follow their licenses.

This project is licensed under the terms of the gnu-gpl-v3.0. Some part of the project base on the licese follow the original project :

• forge-convert-utils
• UnityForgeImporter
• forge-bucketsmanager-desktop
• ChoETL

Dependencies

• Autodesk.Forge - The .NET SDK for Autodesk Forge.
• Newtonsoft.Json - Json.NET is a popular high-performance JSON framework for .NET.
• CsvHelper - Library to help reading and writing CSV files.
• EPPlus - EPPlus is a .NET library that reads and writes Excel files using the Office Open XML format (xlsx).
• ChoETL - Cinchoo ETL is a code-based ETL framework for extracting data from multiple sources, transforming, and loading into your very own data warehouse in .NET environment. You can have data in your data warehouse in no time.
• SharpZipLib - SharpZipLib (#ziplib, formerly NZipLib) is a compression library for Zip, GZip, BZip2.
• Pandas - Pandas is a fast, powerful, flexible and easy to use open source data analysis and data manipulation library built on top of the Python programming language.
• Nuke - Nuke is a cross-platform build automation system with C# DSL for tasks such as compiling code, copying files and folders, running unit tests, compressing files and building NuGet packages.

👨‍🏫 Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

🎁 Sponsors

Thanks JetBrains for providing a free All product IDE for this project.

Disclaimer

This is not an official Autodesk product to support for Autodesk Platform Services. Use it at your own risk.

I'm not responsible for any data loss or any other issues caused by using this library, some features need require cost for using. Please read carefully the Autodesk Forge and Autodesk Platform Services terms of use. I'm just doing, testing , maintaining in free time, so feel free to contribute and make it better.

Update : There is a new, official Node.js/TypeScript SDK that's currently in beta but will be stabilized soon. That SDK will offer various benefits over forge-server-utils, for example, it will be easier to maintain and extend in the future as it's being auto-generated from OpenAPI specs. As soon as it's ready to use (which should be really soon), I would archive this project and point to the official SDK instead.