HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In

Installing pyaoscx

Creating a Virtual Environment

It is recommended that you create a separate virtual environment for this project. This allows your project to have its own isolated environment and dependencies that will not interfere with or be interfered with by other projects' environments and dependencies. More information about virtual environments can be found in the official Python documentation here.

To create a virtual environment, first determine a suitable location for your virtual environment, in which packages and a new separate instance of the Python executable will be installed, and then execute the following command: python3 -m venv /<path>/<to>/<virtual>/<env>

Installing pyaoscx via Pip

Python comes with a package management system, pip. Pip can install, update, or remove packages from the Python environment. Package installations/updates/removal done by pip will apply only to the environment active when the pip command is executed.

We'll want to install pyaoscx in the virtual environment we've created for this project. We can do so with the following steps:

  1. Make sure that the virtual environment is activated by executing the following command:
  • Linux or MacOS shell: $ source /<path>/<to>/<virtual>/<env>/bin/activate
  • Windows Command Prompt: C:\> \<path>\<to>\<virtual>\<env>\Scripts\activate.bat
  1. Install pyaoscx with pip in your activated virtual environment:
  • The recommended method is to install pyaoscx from the official Python Package Index (PyPI). To do so, run the following command: pip install pyaoscx
  • If your machine can't access PyPI, or you're just a maverick who loves to zig when others zag, you can install pyaoscx from an alternative source, our Github repo. To do so, run the following command: pip install git+https://github.com/aruba/pyaoscx

What’s Next