Getting Started

This guide helps you get up and running with pacersdk. It covers installation via pip or source, setting up a virtual environment, and preparing your environment for development or use.

Install from PyPI

The simplest method is to install from the Python Package Index:

pip install -U pacersdk

Install from Source

To install from source (e.g. to contribute or use the latest version):

1. Clone the repository:

   git clone https://github.com/mcpcpc/pacersdk.git
   cd pacersdk/
   

2. Create a virtual environment (optional but recommended):

   python -m venv venv
   

3. Activate the virtual environment:

   • On macOS/Linux:

     source venv/bin/activate
     

   • On Windows:

     venv\Scripts\activate
     

4. Install the package in editable/development mode:

   pip install -e .
   

This setup allows you to modify the code and have changes reflected immediately.