Merge branch 'main' of https://github.com/ebresie/python4nb

Author: ebresie

.github/workflows/codeql-analysis.yml

@@ -19,7 +19,10 @@ on:
     branches: [ main ]
   schedule:
     - cron: '38 13 * * 3'
-
+  workflow_dispatch:
+    # To allow manual workflow execution
+    branches: [ main ]
+  
 jobs:
   analyze:
     name: Analyze
@@ -42,7 +45,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +56,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +70,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.gitignore

@@ -1 +1,2 @@
 /target/
+/nbproject/

README.md

@@ -1,23 +1,62 @@
 # python4nb
-This is Python Plugin for Netbeans which leverages textmate grammar and LSP based functionality.
 
-This is in early development with more work to follow.  This  is being published for further community support and development opportunities.
+This is Python Plugin for [Apache Netbeans](https://netbeans.apache.org/) which leverages textmate grammar and LSP based functionality.
 
-Available Features:
+The source is being published for further community support and development opportunities.
+
+This is in early development with more work to follow.  
+
+Once more development is more mature, expectations is a release will be available here and/or be published to the [Netbeans Plugin Portal]( https://plugins.netbeans.apache.org/).
+
+## Available Features:
+- Python Colorization (via textmate grammar)
+- Auto completion leveraging the Python LSP 
+- Python Hints/Tips leveraging the Python LSP
+- Python Platform Configuration and Installation
+- Python Execution Functionality
+
+# How to install it
+- Installation requires [Python](https://www.python.org/) to be installed
+- Installation of following python LSP related module to be installed in g
+-- python -m pip install python-language-server[all]
+--- For additional details on the [Python LSP server](https://pypi.org/project/python-language-server/)
+- Compile python4nb from source and install module within given Netbeans setup 
+- Open Tools...Python Platform...select python instance where LSP server module installed
+
+# Change process
+- Changes will be tracked using [project's github issues](https://github.com/ebresie/python4nb/issues).
+- Upon completion of updates for given issues, a pull request will be made, reviewed, and upon completion integrated into the master branch in github for coming release.
+
+# Change log
+## Release 0.2
+- [Python Platform Configuration and Installation](https://github.com/ebresie/python4nb/issues/3)
+- [Python Execution Functionality](https://github.com/ebresie/python4nb/issues/4)
+
+## Release 0.1
 - Python Colorization (via textmate gramer)
 - Auto completion leveraging the Python LSP 
 - Python Hints/Tips leveraging the Python LSP
 
-TODO:
-- Complete Python Project functionality
-- Complete Python Platform Configuration and Installation
-- Complete Python Execution Functionality
-- Complete Python Debugging
-- Complete Python Module Management
+For version, will attempt to comply with major/minor/patch versioning as defined [here](https://semver.org/)
+
+## TODO (For more specifics details, see [project issue area](https://github.com/ebresie/python4nb/issues):
+- [Complete Python Project functionality](https://github.com/ebresie/python4nb/issues/8)
+- [Complete Python Debugging](https://github.com/ebresie/python4nb/issues/5)
+- [Complete Python Module Management](https://github.com/ebresie/python4nb/issues/6)
+- [Complete Unit Test functionality](https://github.com/ebresie/python4nb/issues/7)
+- [Complete Implement CI build/packaging for release](https://github.com/ebresie/python4nb/issues/9)
+- [Complete Help and documentation for the python4nb plugin](https://github.com/ebresie/python4nb/issues/10)
+- [Complete Development "New Project" Templates](https://github.com/ebresie/python4nb/issues/11)
+
+# License
+Project is being developed leveraging [Apache-2.0 license]( https://github.com/ebresie/python4nb/blob/main/LICENSE ) or applicable licenses.
+All due diligence has been made to attribute proper licensings where applicable.
 
-Installation requires installation of following python module
-- python -m pip install python-language-server[all]
+Some functionality is based on or leverages functionality from other projects and attempts to comply as applicable.   
+- http://nbpython.org
+- https://netbeans.apache.org/about/oracle-transition.html
+- https://pypi.org/project/python-language-server/
 
-For additional details on the LSP server, see 
-https://pypi.org/project/python-language-server/
+# Contributors
+- [Eric Bresie](https://github.com/ebresie)
 

SECURITY.md

@@ -1,7 +1,7 @@
 # Security Policy
 
 
-Python4NB is in early development so limited sercurity support is available at
+Python4NB is in early development so limited security support is available at
 the moment.
 
 The Python4NB project leverages github workflow dependabot checks 

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.apache.netbeans.modules.python4nb</groupId>
     <artifactId>python</artifactId>
-    <version>0.1-SNAPSHOT</version>
+    <version>0.2-SNAPSHOT</version>
     <packaging>nbm</packaging>
     <build>
         <plugins>
@@ -34,6 +34,11 @@
                     </archive>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.15</version>
+            </plugin>
         </plugins>
     </build>
     <dependencies>   
@@ -82,7 +87,7 @@
             <groupId>org.netbeans.api</groupId>
             <artifactId>org-openide-windows</artifactId>
             <version>RELEASE126</version>
-            <type>jar</type>
+            <!--<type>jar</type>-->
             <scope>provided</scope>
         </dependency>
         <dependency>
@@ -304,6 +309,17 @@
             <version>3.0.2</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-netbeans-modules-nbjunit</artifactId>
+            <version>RELEASE126</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.netbeans.api</groupId>
+            <artifactId>org-netbeans-modules-project-ant</artifactId>
+            <version>RELEASE126</version>
+        </dependency>
     </dependencies>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

src/main/java/org/apache/netbeans/modules/python4nb/api/PythonException.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2022 ebres.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.netbeans.modules.python4nb.api;
+
+/**
+ *
+ * @author ebres
+ */
+public class PythonException extends Exception {
+    
+    public PythonException(Throwable arg0) {
+        super(arg0);
+    }
+
+    public PythonException(String arg0, Throwable arg1) {
+        super(arg0, arg1);
+    }
+
+    public PythonException(String arg0) {
+        super(arg0);
+    }
+
+    public PythonException() {
+    }
+}

src/main/java/org/apache/netbeans/modules/python4nb/api/PythonOutputProcessor.java

@@ -0,0 +1,35 @@
+/*
+ * To change this template, choose Tools | Templates
+ * and open the template in the editor.
+ */
+
+package org.apache.netbeans.modules.python4nb.api;
+
+import java.io.IOException;
+//import org.netbeans.api.extexecution.input.InputProcessor;
+import org.netbeans.api.extexecution.base.input.InputProcessor;
+
+/** TODO: This code is derived from nbPython codebase.  
+ * Need to consider proper handling of code.
+ */
+public class PythonOutputProcessor implements InputProcessor {
+    StringBuilder builder = new StringBuilder();
+    @Override
+    public void processInput(char[] input) throws IOException {
+        builder.append(input);
+    }
+
+    @Override
+    public void reset() throws IOException {
+        //builder = new StringBuilder();
+    }
+
+    @Override
+    public void close() throws IOException {
+
+    }
+    public String getData(){
+        return builder.toString();
+    }
+
+}

src/main/java/org/apache/netbeans/modules/python4nb/api/PythonPlatformListModel.java

@@ -0,0 +1,40 @@
+/*
+ * To change this template, choose Tools | Templates
+ * and open the template in the editor.
+ */
+
+/* TODO: This is based on nbPython code and needs to be reconciled as 
+applicable.
+*/
+package org.apache.netbeans.modules.python4nb.api;
+
+import java.util.List;
+import javax.swing.AbstractListModel;
+//import org.netbeans.modules.python.api.PythonPlatform;
+//import org.netbeans.modules.python.api.PythonPlatformManager;
+import org.apache.netbeans.modules.python4nb.platform.PythonPlatform;
+import org.apache.netbeans.modules.python4nb.platform.PythonPlatformManager;
+
+public class PythonPlatformListModel extends AbstractListModel {
+    private PythonPlatformManager manager = PythonPlatformManager.getInstance();
+    private List<PythonPlatform> model = manager.getPlatforms();
+
+    @Override
+    public int getSize() {
+        return model.size();
+    }
+
+    @Override
+    public Object getElementAt(int index) {
+        if (index >= 0 && index < model.size()) {
+            return model.get(index);
+        } else {
+            return null;
+        }
+    }
+    
+    public void refresh(){
+        model = manager.getPlatforms();
+        fireContentsChanged(this, 0, model.size() -1);
+    }
+}