chore: update doc and add pre-commit

This commit is contained in:
2025-03-11 10:45:26 -06:00
parent 354834fff7
commit 958d87bcae
4 changed files with 40 additions and 10 deletions

23
.pre-commit-config.yaml Normal file
View File

@@ -0,0 +1,23 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: debug-statements
- id: trailing-whitespace
exclude: tests/api-mocks/aiapi.yaml
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.8.2
hooks:
- id: ruff
args: [--fix]
- id: ruff-format
- repo: https://github.com/compilerla/conventional-pre-commit
rev: v3.6.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
args: []

View File

@@ -15,14 +15,14 @@ uv run -m mcontainer.cli
## Lint/Test Commands ## Lint/Test Commands
```bash ```bash
# Run linting # Run linting
uv run --with=ruff ruff check . uvx ruff check .
# Run type checking (note: currently has unresolved stub dependencies) # Run type checking (note: currently has unresolved stub dependencies)
# Skip for now during development # Skip for now during development
# uv run --with=mypy mypy . # uv run --with=mypy mypy .
# Run formatting # Run formatting
uv run --with=ruff ruff format . uvx ruff format .
# Run all tests # Run all tests
uv run -m pytest uv run -m pytest

View File

@@ -1,12 +1,19 @@
# MC - Monadical Container Tool # MC - Monadical Container Tool
MC (Monadical Container) is a command-line tool for managing ephemeral containers that run AI tools and development environments. It works with both local Docker and a dedicated remote web service that manages containers in a Docker-in-Docker (DinD) environment. MC (Monadical Container) is a command-line tool for managing ephemeral
containers that run AI tools and development environments. It works with both
local Docker and a dedicated remote web service that manages containers in a
Docker-in-Docker (DinD) environment.
## Requirements
- [uv](https://docs.astral.sh/uv/)
## Installation ## Installation
```bash ```bash
# Clone the repository # Clone the repository
git clone https://github.com/monadical/mc.git git clone https://github.com/monadical/mcontainer.git
cd mc cd mc
# Install with uv # Install with uv
@@ -71,13 +78,13 @@ Drivers are defined in the `drivers/` directory, with each subdirectory containi
uv run -m pytest uv run -m pytest
# Run linting # Run linting
uv run --with=ruff ruff check . uvx ruff check .
# Run type checking # Run type checking
uv run --with=mypy mypy . uvx mypy .
# Format code # Format code
uv run --with=ruff ruff format . uvx ruff format .
``` ```
## License ## License