primitive 0.4.0

No project description provided

primitive

---

Table of Contents

• Installation
• Configuration
• License
• Development Setup

Installation

pip install primitive

Configuration

Authenticate

primitive config

Register your Hardware

primitive hardware register

License

primitive is distributed under the terms of the MIT license.

Development Setup

For Primitive engineers, you may have these steps completed.

Python Setup

# install required libs for macos
xcode-select --install

# install brew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# install fish
brew install fish
echo /usr/local/bin/fish | sudo tee -a /etc/shells
chsh -s /usr/local/bin/fish

# install fisher
brew install fisher
fisher install jorgebucaran/nvm.fish

# install git
brew install git

# set global info
git config --global user.email "<[e-mail]>"
git config --global user.name “<firstName lastName>”

# install make
brew install make
fish_add_path /opt/homebrew/opt/make/libexec/gnubin

# install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
uv python install
fish_add_path "$(uv python dir)/bin"

Repository Setup

Clone and run setup.

cd ~/Development/primitivecorp/
git clone [e-mail]:primitivecorp/platform.git
cd platform/cli
make setup

With the backend and frontend development environments running, configure the CLI for local use.

# bash or zsh
source .venv/bin/activate
# fish
source .venv/bin/activate.fish

primitive --host localhost:8000 config --transport http
You can find or create a Primitive API token at http://localhost:3000/account/tokens
Please enter your Primitive API token: # create a token and copy the value here
Config created at '/Users/<user>/.config/primitive/credentials.json' on host 'localhost:8000'

# verify the configuration worked via
primitive --host localhost:8000 whoami
Logged in as <username>

Release Process

Version is defined in src/primitive/__about__.py. Bump it, merge to main, and CI handles the rest.

# From the cli/ directory:
make release              # patch bump (0.2.x → 0.2.x+1)
make release BUMP=minor   # minor bump (0.x.y → 0.x+1.0)
make release BUMP=major   # major bump (x.y.z → x+1.0.0)

# Or from the monorepo root:
make cli-release              # patch bump
make cli-release BUMP=minor   # minor bump
make cli-release BUMP=major   # major bump

After merging to main, the CLI: Publish workflow automatically:

1. Detects the version change in src/primitive/__about__.py
2. Creates a git tag (v0.2.x)
3. Creates a GitHub Release with auto-generated notes
4. Builds and publishes to PyPI via trusted publishing (OIDC)