Installation

InstaWebhooks expects that you have Python 3.10 or higher (and pip if you are using it to install) to be installed.

Using pip (recommended)

The recommended way to install is using pip. This allows for easy installation and upgrading.

To install:

$ pip install instawebhooks

To upgrade to its latest release:

$ pip install --upgrade instawebhooks

From development container

Development containers can be used setup your machine for contributing InstaWebhooks.

GitHub Codespaces

1. To get started, click the “Open in GitHub Codespaces” badge or the Code button, then click the Codespaces tab, and “Create codespace on main”

Button to create codespace on main

2. You may be prompted to configure your codespace, you can leave it alone since the default configuration is adequate enough

3. Wait for the codespace to be created and fully loaded. InstaWebhooks will be installed automatically.

For more information about creating a codespace, see Creating a codespace for a repository.

Visual Studio Code

1. Follow the installation steps for Visual Studio Code Dev Containers.

2. Click the “Open in Dev Containers” badge or locally clone this repository and click “Reopen in Container” from the Dev Containers extension.

Notification to reopen in container

3. Wait for the codespace to be created and fully loaded. InstaWebhooks will be installed automatically.

For more information about dev containers in Visual Studio Code, see Developing inside a Container.

From source code

Installing from source code is another option to contribute or use the latest development version.

1. Clone the repository onto your machine

$ git clone https://github.com/ryanlua/instawebhooks.git

2. Navigate to the repository’s directory

$ cd instawebhooks

3. Install the required packages that InstaWebhooks uses:

$ pip install -r requirements.txt

4. Enter Development Mode:

$ pip install --editable .