Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mstuttgart/vscode-odoo-scaffold

Odoo modules made easy
https://github.com/mstuttgart/vscode-odoo-scaffold

hacktoberfest odoo odoo-scaffold python visual-studio-code vscode

Last synced: about 2 months ago
JSON representation

Odoo modules made easy

Awesome Lists containing this project

README

        









Visual Code Odoo Scaffold


A Visual Code extension to create Odoo modules easily



Version


Visual Studio Marketplace Installs


Visual Studio Marketplace Downloads


Visual Studio Marketplace Rating


About |
Requirements |
Installation |
Usage |
Release Notes |
Credits

## About

This extension allow create Odoo modules from explorer windown in easy way.

## Requirements

Work with Odoo 10.0+ and need of `Python Path` configured.

This extension use Odoo [scaffold](https://www.odoo.com/documentation/11.0/reference/cmdline.html#scaffolding) command to generate Odoo modules. To use it, you need to set [odoo-bin](https://github.com/odoo/odoo/blob/11.0/odoo-bin) executable path in settings of vscode.

## Installation

Launch *Quick Open*
- Linux `Ctrl+P`
- macOS `⌘P`
- Windows `Ctrl+P`

Paste the following command and press `Enter`:

```
ext install mstuttgart.odoo-scaffold
```

### Settings

By default the extension uses the configuration from [Python extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-python.python).

To configure Python for your project see [Getting Started with Python in VS Code](https://code.visualstudio.com/docs/python/python-tutorial).

You need to set `odoo-bin` path of you `workspace settings` to made this extension works.

```json
{
"odooScaffold.odooBinPath": "absolute/path/to/odoo-bin",
"pythonVirtualEnv": "absolute/path/to/virtualenv/bin/python",
"odooTemplatePath": "absolute/path/to/moduletemplate" // optional
}
```

## Usage

### From window explorer

Right click on Explorer Window and click in `New Odoo Module`.

![feature X](https://raw.githubusercontent.com/mstuttgart/vscode-odoo-scaffold/develop/images/screenshot.png)

Confirme the selected path (press `Enter`) and type the new module name and press `Enter`.

![feature X](https://raw.githubusercontent.com/mstuttgart/vscode-odoo-scaffold/develop/images/screenshot_1.png)

### From command panel

Press `ctrl+shift+p` to open command panel and type `Python: New Odoo Module`.

Type the path of where new module will be create:

![feature X](https://raw.githubusercontent.com/mstuttgart/vscode-odoo-scaffold/develop/images/screenshot2.png)

Type the name of new module:

![feature X](https://raw.githubusercontent.com/mstuttgart/vscode-odoo-scaffold/develop/images/screenshot_1.png)

## Release Notes

See [changelog](CHANGELOG.md).

## Credits

Copyright (C) 2018-2023 by Michell Stuttgart