Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chuongmep/aps-bot

Explore Data By CLI With Autodesk Platform Services
https://github.com/chuongmep/aps-bot

aps autodesk-forge autodesk-platform-services cli data-analysis data-science forge

Last synced: 3 days ago
JSON representation

Explore Data By CLI With Autodesk Platform Services

Host: GitHub
URL: https://github.com/chuongmep/aps-bot
Owner: chuongmep
Created: 2024-06-08T15:38:42.000Z (4 months ago)
Default Branch: master
Last Pushed: 2024-07-10T06:46:40.000Z (3 months ago)
Last Synced: 2024-09-25T21:58:56.429Z (8 days ago)
Topics: aps, autodesk-forge, autodesk-platform-services, cli, data-analysis, data-science, forge
Language: Python
Homepage: https://chuongmep.com/posts/2024-06-12-aps-cli-ai.html
Size: 36.9 MB
Stars: 9
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# APSBot: Autodesk Platform Services CLI

Welcome to the CLI tool `apsbot`, designed to interact seamlessly with the Autodesk Platform Services (formerly Autodesk Forge) API. This tool provides a command-line interface to access and manage data across various Autodesk services.

![](docs/apsbot.png)

## Features

- Interactive with data by Command Line Interface(CLI)
- Snooping Data Around Autodesk Services (Hubs, Projects, Items, Versions, Folders, Buckets, etc.)
- Analyzing Revit Data
- Chat With AI Bot (OpenAI) to do data analysis and have fun.

## Installation

- Install [python](https://www.python.org/downloads/) version 3.9 or higher
- Install python package from [pypi](https://pypi.org/project/apsbot/)

```bash
pip install apsbot --upgrade
```

## Requirements

Setup environment variables

```bash
APS_CLIENT_ID = "your_client_id"
APS_CLIENT_SECRET = "your_client_secret"
OPENAI_API_KEY = "your_openai_api_key"
```

## Usage

- Command `apsbot` in terminal or command prompt to start :

![apsbot](docs/apsbot-macos.gif)

```bash
apsbot [OPTIONS] COMMAND [ARGS]...
```

- Without setting path configuration
```bash
python -m apsbot [OPTIONS] COMMAND [ARGS]...
```

Notes : `python -m` use when your computer can't find the `apsbot` command.

Let's start with `hubs` and `projects` command to list all hubs in your account.

![](docs/hubs-projects.gif)

Chat With AI Bot (OpenAI) to do data analysis and have fun.

![](docs/chat.gif)

Revit Data Analysis Example :

![](docs/revit-rooms.png)

... More, please explore by yourself.

## Contributing

Please read [dev.md](./docs/dev.md) for details on our code of conduct, and the process for submitting pull requests to us. I'm happy to receive your contributions.

## Disclaimer

This is project just play for fun with free time weekend. Please use it at your own risk. I am not responsible for any damage caused by this project.

## Many thanks

I have a lot of inspiration from this topic :

- https://www.travisluong.com/how-to-build-a-command-line-interface-tool-with-python-pandas-typer-and-tabulate-for-data-analysis/