Changes between Version 26 and Version 27 of j2p

Timestamp:

06/20/23 11:44:50 (17 months ago)

Author:

wouter

Comment:

--

j2p

@@ -27 +27 @@
 
 == Usage
+For usage you have the choice between translating a single file or an entire package. We generally recommend translating the entire package.
+
+=== Single File
+If you want to translate a single java file or even just a string containing your program, that does not need any specialized libraries, you can do the approach as many tests in core do. Check the examples. The heart of the code will look like this, where most boilerplate is about setting up the javaparser:
+
+{{{
+                ParserConfiguration conf = new ParserConfiguration();
+                CombinedTypeSolver typeSolver = new CombinedTypeSolver();
+                typeSolver.add(new ReflectionTypeSolver(false));
+                JavaSymbolSolver symbolSolver = new JavaSymbolSolver(typeSolver);
+                conf.setSymbolResolver(symbolSolver);
+                JavaParser parser = new JavaParser(conf);
+                ParseResult<CompilationUnit> res = parser.parse(new File(javaFile));
+
+                Block translation = Translator.translate(res.getResult().get());
+
+}}}
+
+After you get the translation, you can print it or put it in a {{{.py}}} file.
+
+=== Entire Package
+If you want to translate an entire package, first create a separate source directory containing all the java code that you want to translate. Also make sure that your code is compiled (eg, using the build-helper-maven-plugin , check the pom files). Then you just do
+{{{
+PyProgram program = PyProgram.fromDirectory(Paths.get("src/test/myprogram"));
+}}}
+
+This gives you a fully translated program that you can print or get a zip file from. To get a zip file, call
+{{{program.getZip() }}}
+
+The zip file is ready for a pip install (eg in your own virtual environment) or running from java through our PythonVenv.
+
 
 == Overriding the translation