Metadata-Version: 2.1
Name: orhelper
Version: 0.1.0
Summary: OrHelper is a module which aims to facilitate interacting and scripting with OpenRocket from Python.
Home-page: https://github.com/SilentSys/orhelper
Author: Andrei Popescu
Author-email: Popescu.Andrei.David@gmail.com
License: UNKNOWN
Description: # orhelper
        orhelper is a module which aims to facilitate interacting and scripting with OpenRocket from Python.
        
        ## Prerequisites
        - Java JDK 1.8
             - [Open JDK 1.8](https://github.com/ojdkbuild/ojdkbuild)
             - [Oracle JDK 8](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html) (requires signup)
             - Ubuntu: `sudo apt-get install openjdk-8-jre`
        - Python >=3.6
        - Pipenv for dependency management
        
        ## Setup JDK
        
        ### Linux
        - Export JAVA_HOME environment variable
            ```
            JAVA_HOME=/usr/lib/jvm/[YOUR JDK 1.8 FOLDER HERE]
            ```
        
        ### Windows
        
        - Set Windows environment variables to the following:
            - Oracle
                ```
                JAVA_HOME=C:\Program Files\Java\[YOUR JDK 1.8 FOLDER HERE]
                ```
            - OpenJDK
                ```
                JAVA_HOME=C:\Program Files\ojdkbuild\[YOUR JDK 1.8 FOLDER HERE]
                ```
        
        ## Installing
        
        - Install orhelper from pip
            ```
            pip install orhelper
            ```
        
        - [Download](https://github.com/openrocket/openrocket/releases/download/release-15.03/OpenRocket-15.03.jar) the OpenRocket .jar file (if you don't already have it)
            - Linux  
                ```
                wget https://github.com/openrocket/openrocket/releases/download/release-15.03/OpenRocket-15.03.jar
                ```
        
        - Set environment variable `CLASSPATH` path to OpenRocket .jar file. (Only required if it's not already at `.\OpenRocket-15.03.jar`)
            ```
            CLASSPATH=\some\path\to\OpenRocket-15.03.jar
            ```
        
        - see `examples/` for usage examples
        - see [the OpenRocket wiki](https://github.com/openrocket/openrocket/wiki/Scripting-with-Python-and-JPype) for more info on on usage and the examples 
        
        
        ## Credits
        - Richard Graham for the original script: [Source](https://sourceforge.net/p/openrocket/mailman/openrocket-devel/thread/4F17AA0C.1040002@rdg.cc/)
        - @not7cd for some initial organization and clean-up: [Source](https://github.com/not7cd/orhelper)
        - And of course everyone who has contributed to OpenRocket over the years.
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
