Skip to content

installation.md

Latest commit

 

History

History
146 lines (94 loc) · 2.9 KB

installation.md

File metadata and controls

146 lines (94 loc) · 2.9 KB
Raw

Installation Guide

Prerequisites

  • Python 3.11 or later (Python 3.11.0+ is officially supported)
  • uv package manager

Installation Options

Choose your preferred installation method:

Option 1: Persistent Installation (Recommended)

Install mp once and use it everywhere. This method keeps the tool available in your PATH.

# Install from the main branch
uv tool install mp --from git+https://github.com/chronicle/content-hub.git#subdirectory=packages/mp

Then use the tool directly:

# Check version
mp --version

# View help
mp --help

To upgrade mp:

uv tool upgrade mp

Option 2: One-time Usage

Run mp directly without installing:

# Run latest from main
uvx --from git+https://github.com/chronicle/content-hub.git#subdirectory=packages/mp mp --help

Option 3: Manual Installation (Development)

This method is recommended if you are developing the mp tool itself or want to use it within a local checkout.

1. Clone the Repository

git clone <repository-url>
cd packages/mp

3. Set Up Project with uv

Development Installation

For development purposes, create a virtual environment and install dependencies in one step:

uv sync --dev

This command creates a virtual environment in .venv directory and installs all dependencies including development ones.

User Installation

For regular usage without development dependencies:

uv sync

4. Activate the Virtual Environment

source .venv/bin/activate  # On Windows: .venv\Scripts\activate

5. Verify Installation

Verify that the installation was successful by running:

mp --help

You should see the help menu displaying the available commands.

Note

Windows Users: if you are running on Windows, please use wmp instead of mp (e.g., wmp --help).

Alternative: Direct Installation

You can also install the package directly to your base Python interpreter:

uv pip install .
# Or for development installation
uv pip install -e .

Configure mp

When installing mp it automatically assumes the marketplace repo is installed at ~/marketplace. To configure a different path run

mp config --root-path /path/to/marketplace

To find more about configurations, run

mp config --help

IDE Configuration

To run or debug the application from within an IDE, please make sure to set the project's Python interpreter to the executable located within the virtual environment created by uv. the relative path from packages/mp is:

  • Windows: .venv\Scripts\python.exe

  • macOS/Linux: .venv/bin/python

This ensures that the IDE can correctly utilize any shared run/debug configurations.

Dependencies

If you need to update dependencies or re-sync your virtual environment:

uv sync

For development, also sync the dev-dependencies

uv sync --dev