📌
MBPY: Schools Technology
  • About this Resource
  • Installation
    • Requirements
    • Getting Started Local Install
    • Getting Started using Docker
    • Further instructions with Docker
    • Updating with Docker
  • Tutorials
    • Configuration
    • Importing
    • Extracting
    • Streaming
    • Pipelines
    • Scripting
    • Big Query
  • Querying & Tranformations
    • Querying Commands
    • Querying the Database
    • Querying via Script
    • Querying via an SQLite Client
  • Scripts
    • Daily Homeroom Attendance Report
  • Pipelines
    • Dataframes with pandas
    • Pipelines
    • Example Pipelines
      • Bulk Change Email domain
      • Enrollment by Gender
  • Plugins
    • mbpy_powerschool_plugin
      • PowerSchool Plugin
        • API reference
      • mbpy Plugin
        • mbpy plugin source code
    • Plugins Overview
    • mbpy_plugin_example
    • mbpy_plugin_destiny
    • mbpy_plugin_attendance_reports
Powered by GitBook
On this page
  • Local installation tutorial
  • Installling with pipx
  • Configure
  • Updating
  • Local Development Install

Was this helpful?

Export as PDF
  1. Installation

Getting Started Local Install

PreviousRequirementsNextGetting Started using Docker

Last updated 1 year ago

Was this helpful?

Local installation tutorial

There are some requirements for local installation:

  1. Have access to the repos (mbpy endpoints and mbpy) and accepted the invites

  2. Authenticated with github

    1. Install utility. This will authenticate your device with github.

      1. On Mac, you can use to install it: brew install gh

    2. Once the gh command is installed, use it to login: gh auth login

      1. Use HTTPS method, and either choose to login via browser or use a token

    3. Alternatively, you could

  3. Have pipx

    1. On Mac, brew install pipx and then pipx ensurepath

    2. On Linux, python3 -m pip install --user pipx and then python3 -m pipx ensurepath

Installling with pipx

Remember you have to be logged in to github for this to work gh auth login as above:

pipx install git+https://github.com/classroomtechtools/mbpy.git

You may need to specify exactly which python version to use, which you can by pass an explicit path to the python version, as demonstrated here:

pipx install git+https://github.com/classroomtechtools/mbpy.git --python $(which python3.11)

Configure

Every time you want to add a school to mbpy, it needs to be configured. Learn how here:

Updating

pipx upgrade mbpy
mbpy db migrate

Local Development Install

To develop mbpy or expand its functionality, use poetry:

git clone --recurse-submodules https://github.com/classroomtechtools/mbpy.git
cd mbpy
poetry install

After that, you can use poetry shell from that directory, add breakpoints etc and hack away. Use mpby commands like usual.

gh command line
brew
use a Personal Acccess Token.
installed
Configuration