primitive 0.1.63

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 pyenv (python version manager)
brew install pyenv
set -Ux PYENV_ROOT $HOME/.pyenv
fish_add_path $PYENV_ROOT/bin
echo 'pyenv init - | source' >> ~/.config/fish/config.fish

# install the latest version of python
pyenv install 3.12.2
pyenv global 3.12.2
pip install --upgrade pip

# install uv
pip install uv

Repository Setup

Clone and run setup.

cd ~/Development/primitivecorp/
git clone [e-mail]:primitivecorp/primitive-cli.git
cd primitive-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
Username []: <username> # find this on the frontend app at [http://localhost:3000](http://localhost:3000)
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' for user '<username>' on host 'localhost:8000'

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