Skip to content

INSTALL.md

Latest commit

 

History

History
133 lines (91 loc) · 2.62 KB

INSTALL.md

File metadata and controls

133 lines (91 loc) · 2.62 KB
batch
batch_id batch_title doc_id heading_title url
batch_1QimKT4Fd-ibsyS7eXOeE0myXs1v3PaS5jdER6dZfdGw
Order Test Fixed
1QimKT4Fd-ibsyS7eXOeE0myXs1v3PaS5jdER6dZfdGw
Install

Installation Guide

Method 1: Homebrew (Recommended for macOS)

The easiest way to install mdsync on macOS:

brew install chasemp/tap/mdsync

This automatically installs mdsync and all required dependencies.

Update mdsync

brew upgrade mdsync

Uninstall mdsync

brew uninstall mdsync

Method 2: Install Locally

Install mdsync as a command-line tool that you can run from anywhere:

# From the project directory
pip install -e .

The -e flag installs in "editable" mode, so any changes you make to the code will be reflected immediately.

After installation, you can use the mdsync command from anywhere:

mdsync --help
mdsync file.md --create -u | pbcopy

Uninstall

pip uninstall mdsync

Method 2: Install from GitHub

You can also install directly from GitHub:

pip install git+https://github.com/chasemp/mdsync.git

Method 3: Run Directly (No Installation)

If you prefer not to install, you can run the script directly:

./mdsync.py --help

Verify Installation

After installation, verify it works:

mdsync --help

You should see the help message with all available options.

Setting Up Credentials

Regardless of installation method, you still need to set up Google API credentials:

  1. Follow the instructions in SETUP_GUIDE.md
  2. Place your credentials.json file in:
    • If installed: ~/.config/mdsync/credentials.json (or current directory)
    • If running directly: Same directory as mdsync.py

The script will look for credentials in the following order:

  1. Current directory
  2. ~/.config/mdsync/
  3. ~/.mdsync/

Virtual Environment (Optional but Recommended)

If you want to keep dependencies isolated:

# Create virtual environment
python3 -m venv venv

# Activate it
source venv/bin/activate  # On macOS/Linux
# or
venv\Scripts\activate  # On Windows

# Install
pip install -e .

# Use mdsync
mdsync --help

Troubleshooting

Command not found

If mdsync command is not found after installation:

  1. Make sure pip's bin directory is in your PATH
  2. Try reinstalling: pip uninstall mdsync && pip install -e .
  3. Check where it was installed: pip show mdsync

Permission denied

If you get permission errors:

# Use --user flag
pip install --user -e .