mirror of
https://github.com/usnistgov/macos_security.git
synced 2026-08-11 23:41:45 +01:00
56 lines
1.2 KiB
Markdown
56 lines
1.2 KiB
Markdown
# How to setup project to run on your local machine
|
|
|
|
## Requirements
|
|
|
|
- Python >= 3.12.1
|
|
|
|
## Python Instructions
|
|
|
|
Follow the below instructions to setup the environment to work with the project.
|
|
|
|
### Create virtual environment
|
|
|
|
```bash
|
|
python3 -m venv .venv
|
|
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
### Update pip and install python requirements
|
|
|
|
```bash
|
|
python3 -m pip install --upgrade pip
|
|
|
|
python3 -m pip install --upgrade -r requirements.txt
|
|
```
|
|
|
|
You can now run the `./mscp.py` CLI to get started.
|
|
|
|
## Ruby instructions (optional)
|
|
|
|
The ruby components and configuration will take place the first time `./mscp.py guidance` is executed. The instructions here are for information and troubleshooting purposes.
|
|
|
|
### Setup bundle configuration file
|
|
|
|
```bash
|
|
bundle config path mscp_gems
|
|
bundle config bin mscp_gems/bin
|
|
```
|
|
|
|
### Install ruby tools
|
|
|
|
```bash
|
|
bundle install
|
|
bundle binstubs --all
|
|
```
|
|
|
|
## Install as python module for development (optional)
|
|
|
|
Installing mSCP as a python module will allow developers to leverage the API to work with the MSCP data.
|
|
|
|
```bash
|
|
python3 -m pip install git+https://github.com/usnistgov/macos_security@main
|
|
```
|
|
|
|
You can now use the MSCP modules by way of `import mscp` in your own python tool.
|