https://github.com/elonzh/office-addin-sideloader
A handy tool to manage your office addins locally, you can use it for addin development or deploy your addins for your clients out of AppSource.
https://github.com/elonzh/office-addin-sideloader
office office-addin windows
Last synced: over 1 year ago
JSON representation
A handy tool to manage your office addins locally, you can use it for addin development or deploy your addins for your clients out of AppSource.
- Host: GitHub
- URL: https://github.com/elonzh/office-addin-sideloader
- Owner: elonzh
- License: mit
- Created: 2021-08-03T10:51:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-22T05:55:22.000Z (over 3 years ago)
- Last Synced: 2025-03-19T02:38:12.548Z (over 1 year ago)
- Topics: office, office-addin, windows
- Language: Python
- Homepage:
- Size: 174 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Office Addin Sideloader
[](https://pypi.org/project/oaloader/)
A handy tool to manage your office addins locally,
you can use it for addin development or deploy your addins for your clients out of AppSource.
> NOTE: currently only support windows.
## Features
- Add or remove Office Add-in locally.
- Support local or url manifest source.
- Debug sideload status and list manifest info.
- Single binary without any dependency.
- Use it as a library.
- Generate add-in installer/uninstaller with [sentry](https://sentry.io) support by single command.
- Support fixing add-in [APP ERROR](https://docs.microsoft.com/en-us/office365/troubleshoot/installation/cannot-install-office-add-in) and [clearing cache](https://docs.microsoft.com/en-us/office/dev/add-ins/testing/clear-cache).
## Installation
### Pre-built releases
If you just use the command line and don't have a python environment,
download pre-built binary from [GitHub Releases](https://github.com/elonzh/office-addin-sideloader/releases).
### Pypi
```shell
> pip install oaloader
```
## Quick Start
```text
> ./oaloader.exe --help
Usage: [OPTIONS] COMMAND [ARGS]...
Manage your office addins locally.
Options:
--version Show the version and exit.
-l, --level TEXT The log level [default: info]
--help Show this message and exit.
Commands:
add Register catalog and add manifests, manifests can be file paths
or...
fix Try fixing `APP ERROR` when starting up add-ins.
info Debug sideload status.
remove Remove manifest from catalog and manifest can be a file path or...
```
## Build an Addin installer
1. Install [Poetry](https://python-poetry.org/docs/).
2. Run `poetry install` to prepare environment.
3. Checkout [Nuitka Requirements](https://nuitka.net/doc/user-manual.html#requirements) and install a C compiler.
4. Run `poetry run invoke installer -m ` to build your own installer.
If your want customize the installer, just edit `installer.jinja2` or write your own installer with `oaloader` module.
## Build an Addin uninstaller
Just using invoke `uninstaller` task like `installer` above.
## FAQ
### How it works?
https://docs.microsoft.com/en-us/office/dev/add-ins/testing/create-a-network-shared-folder-catalog-for-task-pane-and-content-add-ins
### Get error like `ImportError: DLL load failed while importing win32xxx` when import pywin32 module.
Try this solution:
1. Open a terminal as Administrator
2. Get your virtualenv path by running `poetry env info`
3. Run `poetry run python /.venv/Scripts/pywin32_postinstall.py -install`
see https://github.com/mhammond/pywin32/issues/1431#issuecomment-548584385 for more details.