|
1 | | -# 🚀 Odoo Autocomplete Plugin |
| 1 | +# 🚀 Odoo Autocompletion Support (v1.0.2) |
2 | 2 |
|
3 | | -An enhanced IntelliJ/PyCharm plugin for Odoo development. It provides advanced autocompletion, code navigation, and inspections to supercharge your workflow. Supports all Odoo versions! |
| 3 | +A modern, production-ready plugin for PyCharm Community Edition and IntelliJ IDEA, designed to supercharge Odoo development. |
4 | 4 |
|
5 | | -## ✨ Features |
6 | | - |
7 | | -- **Full Autocompletion:** For Models, Record XML IDs, Actions, Views, Menus, Groups, and more across Python, XML, and CSV files. |
8 | | -- **Go To Declaration:** Instantly navigate to the definition of any Odoo entity. |
9 | | -- **JavaScript Support:** Autocompletion and navigation for JS modules defined with `odoo.define`. |
10 | | -- **Translation Support:** Autocompletion and navigation for `msgid` entries from PO/POT files. |
11 | | -- **Smart Inspections:** Get warnings for missing models, records, JS modules, and translations. |
12 | | -- **High Performance:** Built with a powerful indexing engine for a fast and smooth developer experience. |
13 | | - |
14 | | -## 🛠️ Installation |
15 | | - |
16 | | -1. **Build the plugin:** |
17 | | - ```bash |
18 | | - ./gradlew buildPlugin |
19 | | - ``` |
20 | | -2. The plugin `.jar` file will be created in the `build/libs/` directory. |
21 | | -3. **Install in your IDE:** |
22 | | - - In PyCharm/IntelliJ, go to `File > Settings > Plugins`. |
23 | | - - Click the gear icon ⚙️ and select **"Install Plugin from Disk..."**. |
24 | | - - Choose the `.jar` file you just built. |
25 | | -
|
26 | | -## 📚 Documentation |
27 | | -
|
28 | | -For a detailed list of features, supported entities, and usage examples, please see the full documentation: [documentation/README.md](documentation/README.md). |
| 5 | +--- |
29 | 6 |
|
30 | | -## 📄 License |
31 | | -
|
32 | | -This project is licensed under the MIT License. See the [License.txt](License.txt) file for details. |
33 | | -
|
34 | | -## 🧑💻 Authorship |
35 | | -
|
36 | | -Copyright (c) 2024 AlexTkDev. |
37 | | -
|
38 | | -Based on the original work by `wt-io-it/odoo-pycharm-plugin`. |
39 | | -
|
40 | | -# Installing |
| 7 | +## ✨ Features |
| 8 | +- **Full Autocompletion:** Models, fields, XML-IDs, manifests, and more in Python and XML. |
| 9 | +- **Go to Declaration:** Instantly navigate to models, fields, records, and references. |
| 10 | +- **Inspections & Quickfixes:** For missing models, records, and manifest errors. |
| 11 | +- **Odoo-specific Code Generation:** Fast creation of Odoo models and records. |
| 12 | +- **Documentation Popups:** Inline Odoo docs for models and fields. |
| 13 | +- **Manifest & Security Support:** Navigation and validation for manifest and security files. |
| 14 | +- **Marketplace-ready:** All code and UI in English, ready for JetBrains Marketplace. |
| 15 | +- **No Ultimate dependencies, no license checks, fully open source.** |
41 | 16 |
|
42 | | -The Plugin will be made available in the [JetBrains Plugin Repository](https://plugins.jetbrains.com/plugin/13083-odoo-support-for-pycharm) |
| 17 | +--- |
43 | 18 |
|
44 | | -Alternatively you can install it as a local file |
45 | | -* Download [odoo_plugin.jar](odoo_plugin.jar) |
46 | | -* In PyCharm in File > Settings > Plugin select the gear icon. |
47 | | -* Select install plugin from disk and choose the downloaded odoo_plugin.jar |
| 19 | +## 📦 Installation |
| 20 | +1. Download the latest release from [GitHub Releases](https://github.com/AlexTkDev/odoo-autocomplete-plugin/releases) or build from source: |
| 21 | + ```bash |
| 22 | + ./gradlew clean build --no-build-cache --refresh-dependencies |
| 23 | + ``` |
| 24 | +2. In PyCharm: Preferences → Plugins → Install plugin from disk → select the built `.zip` file. |
| 25 | +3. Restart PyCharm. |
48 | 26 |
|
49 | | -# Contributing |
| 27 | +--- |
50 | 28 |
|
51 | | -## Checkout and open Odoo Autocompletion Plugin in IntelliJ IDEA |
| 29 | +## 📚 Documentation & Support |
| 30 | +- **Repository:** [github.com/AlexTkDev/odoo-autocomplete-plugin](https://github.com/AlexTkDev/odoo-autocomplete-plugin) |
| 31 | +- **Documentation:** [Full documentation](https://github.com/AlexTkDev/odoo-autocomplete-plugin/blob/master/documentation/README.md) |
| 32 | +- **Issues & Feedback:** [GitHub Issues](https://github.com/AlexTkDev/odoo-autocomplete-plugin/issues) |
52 | 33 |
|
53 | | -1. git clone https://github.com/wt-io-it/odoo-pycharm-plugin.git into a directory |
54 | | -1. Open a new project by selecting File > New > Project from Version Control > Git |
55 | | -1. Enter `https://github.com/wt-io-it/odoo-pycharm-plugin.git` into the Field URL |
56 | | -  |
57 | | -1. Start coding |
| 34 | +--- |
58 | 35 |
|
59 | | -## Agreement to publish the code in the Jetbrains Plugin Repository |
| 36 | +## 📝 License |
| 37 | +MIT License. Copyright (c) 2024 AlexTkDev. |
60 | 38 |
|
61 | | -By contributing you agree that this plugin is also published in the JetBrains Plugin Repository under the terms of the |
62 | | -JetBrains Plugin Marketplace Developer Agreement |
| 39 | +--- |
| 40 | +Odoo® is a registered trademark of Odoo S.A. This plugin is an independent open-source project and is not affiliated with Odoo S.A. |
63 | 41 |
|
64 | | -# Development HowTos |
65 | | -## Build Plugin |
66 | | -To build the plugin perform the following steps |
67 | | -* checkout the version you want to build |
68 | | -* run `./gradlew buildPlugin` |
69 | | -## Install Development Version of the Plugin |
70 | | -> Development versions are marked with -SNAPSHOT |
71 | | -* Build the plugin as descriped above |
72 | | -* In PyCharm / IntelliJ open File > Settings |
73 | | -* Select Plugins |
74 | | -* Select the gear icon above the plugin list and select "Install Plugin from Disk ..." |
75 | | - |
76 | | -* Select the plugin jar file from [build/libs](build/libs) directory and click "OK" |
77 | | -* Click the "Restart IDE" button to apply the new version of the plugin: |
78 | | - |
79 | | -## Publish a new version |
80 | | -* test plugin with `./gradlew test` |
81 | | -* test plugin manually by installing it |
82 | | -* review changelog |
83 | | -* change -SNAPSHOT version to non snapshot version and perform release commit |
84 | | -* verify the plugin with `./gradlew verifyPlugin && ./gradlew runPluginVerifier` |
85 | | -* submit plugin to jetbrains review process with `./gradlew publishPlugin` |
86 | | -* tag commit as version with `vN.N.N` |
87 | | -* push commit and tag |
88 | | -* prepare version numbers for next version and commit |
89 | | -* push commit |
| 42 | +*This README is up to date for version 1.0.2 and the 2025.1+ JetBrains platform.* |
0 commit comments