Language - Python Windows PyCharm: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
Line 18: Line 18:
The recommended way to install the '''Phidget22 Python module''' is using the '''PIP package manager'''.
The recommended way to install the '''Phidget22 Python module''' is using the '''PIP package manager'''.
<br><br>
<br><br>
To install the Phidget22 libraries for your current PyCharm project with PIP, first open '''File > Settings'''
You can install the Phidget22 libraries for your current PyCharm project with PIP by opening '''File > Settings'''
[[File:PyCharm_Settings.png|link=|center|800px]]
[[File:PyCharm_Settings.png|link=|center|800px]]
<br><br>
<br><br>
Next, navigate to '''Project > Project Interpreter''' and click on the '''+''' symbol located on the right hand side:
Next, navigate to '''Project > Project Interpreter''' and click on the + symbol located on the right hand side:
[[File:PyCharm_Interpreter.png|link=|center|800px]]
[[File:PyCharm_Interpreter.png|link=|center|800px]]
<br><br>
<br><br>
Type Phidget22 into the search bar, select the package named '''Phidget22''' and click Install Package:
Type Phidget22 into the search bar, select the package named '''Phidget22''' and click Install Package:
<br>''Ensure you select the package named '''Phidget22'''. Other PIP users have created non-official packages for Phidgets.''
[[File:PyCharm_Install_Phidget22.png|link=|center|800px]]
[[File:PyCharm_Install_Phidget22.png|link=|center|800px]]
|-|
|-|
Line 61: Line 60:
}}
}}


==Use our examples==
{{Finding Code Samples|Python}}
One of the best ways to start programming with Phidgets is to use our example code as a guide. Before we get started, make sure you have read [[#Install Phidget Python module for Windows | how to install the Phidget Python module]] section above. You will also need to download [https://www.jetbrains.com/pycharm/ PyCharm] if you have not already.


Now that you have Python and the Phidget Python module installed, as well as PyCharm, select an example that will work with your Phidget:
==Using the Code Samples==
*{{SampleCode|Python|Python Examples}}


Click the '''Download Example''' button to download a Java file with the sample code:


Next, create a new Python project:
[[Image:Java_Sample_Code_Download.png|link=|center|border|800px]]
[[Image:Python_pycharm_newproject.PNG|link=|center]]




Add the example you just downloaded by dragging it into the project. Be sure to include ''PhidgetHelperFunctions.py'', as it is used by the example code:
Add the example you just downloaded by dragging it into the project:
 
[[Image:Python_pycharm_import.png|link=|center|850px]]
[[Image:Python_pycharm_import.png|link=|center|850px]]


Finally, run the project:
Finally, run the project:
[[Image:Python_pycharm_run.png|link=|center|850px]]
[[Image:Python_pycharm_run.png|link=|center|850px]]


If prompted, select the example file to be run:
If prompted, select the example file to be run:
[[Image:Python_pycharm_select_python_file.png|link=|center|850px]]
[[Image:Python_pycharm_select_python_file.png|link=|center|850px]]


{{Edit_the_Examples}}
{{Language_-_Python_Editing_The_Examples}}
==Setting Up a New Project==
When you are building a project from scratch, or adding Phidget functionality to an existing project, you'll need to configure your development environment to properly link the Phidget Python library.
To start, create a new Python project:
[[Image:Python_pycharm_newproject.PNG|link=|center]]
Next, add a new file to the project:
[[Image:Python_pycharm_newfile.PNG|link=|center|850px]]
Name the new file with a fitting name:
[[Image:Python_pycharm_newfile_2.PNG|link=|center]]
To include the Phidget Python library, add the following imports to your code:
<syntaxhighlight lang=python>
from Phidget22.PhidgetException import *
from Phidget22.Phidget import *
</syntaxhighlight>
Then, you will also have to import the class for your particular Phidget. For example, you would include the following line for a DigitalInput:
<syntaxhighlight lang=python>
from Phidget22.Devices.DigitalInput import *
</syntaxhighlight>
[[Image:Python_pycharm_newfile_3.PNG|link=|center|850px]]


The project now has access to Phidgets.
The project is now running with Phidgets!


{{Language Page What's Next}}
{{Language Page What's Next}}

Revision as of 22:23, 16 October 2019

Language - Python

Windows with PyCharm

Welcome to using Phidgets with Python! By using Python, you will have access to the complete Phidget22 API, including events.

PyCharm is an integrated development environment for Python by JetBrains.

Install Phidget Drivers for Windows

Before getting started with the guides below, ensure you have the following components installed on your machine:

  1. You will need the Phidgets Windows Drivers
  2. You will need a version of Python installed on your machine (2.7 and 3.6+ are compatible with Phidgets).


The recommended way to install the Phidget22 Python module is using the PIP package manager.

You can install the Phidget22 libraries for your current PyCharm project with PIP by opening File > Settings

PyCharm Settings.png



Next, navigate to Project > Project Interpreter and click on the + symbol located on the right hand side:

PyCharm Interpreter.png



Type Phidget22 into the search bar, select the package named Phidget22 and click Install Package:

PyCharm Install Phidget22.png

The recommended way to install the Phidget22 Python module is using the PIP package manager.

Python versions 2.7.9+ and 3.4+ include PIP by default.

To install the Phidget22 Python module with PIP, simply open the Command Prompt (press the Windows key and search for "cmd"), and enter the command: 

python -m pip install Phidget22

To install the Phidget22 libraries to a specific Python version, you can use the Python Windows Launcher from the Command Prompt as follows (replace -X.X with your Python version, e.g. -2.7 or -3.6): 

py -X.X -m pip install Phidget22

To use the global Phidget22 library in your PyCharm project, select Inherit global site-packages when creating a new project.

PyCharm Inherit Global Packages.png

To install the Phidget22 Python module without PIP, you will need to download the Phidget22 Python module.

After unpacking the Phidget22 Python module, open the Command Prompt (press the Windows key and search for "cmd") Locate the folder where you downloaded the Python module and enter the following command: 

python setup.py install

This will build the module and install the Python module files into your site-packages directory.

Python install.png

Finding Code Samples

To find the code sample to use for your Phidget, navigate to the Code Samples page and select your device from the drop-down menu.

Python sample code.jpg


Once you select your device, the code sample generator will give you a working code sample, and a selection of options to customize it to your needs.

Using the Code Samples

Click the Download Example button to download a Java file with the sample code:

Java Sample Code Download.png


Add the example you just downloaded by dragging it into the project:

Python pycharm import.png


Finally, run the project:

Python pycharm run.png


If prompted, select the example file to be run:

Python pycharm select python file.png


The project is now running with Phidgets!

What's Next?

Now that you have set up Phidgets to work with your programming environment, we recommend you read our guide on Phidget Programming Basics to learn the fundamentals of programming with Phidgets.Next Arrow.png


Retrieved from "https://www.phidgets.com/docs/index.php?title=Language_-_Python_Windows_PyCharm&oldid=31558"