mirror of
https://github.com/latinogino/dolibarr-mcp.git
synced 2026-04-12 05:45:35 +02:00
b059d9c40e
- Add create_invoice_draft, add_invoice_line, update_invoice_line, delete_invoice_line, set_invoice_project, validate_invoice tools - Update DolibarrClient with corresponding methods - Add tests for atomic invoice operations - Update development docs with venv instructions
62 lines
1.5 KiB
Markdown
62 lines
1.5 KiB
Markdown
# Development
|
||
|
||
This project uses the same lightweight tooling philosophy as `prestashop-mcp`.
|
||
The code lives under `src/`, tests under `tests/` and optional Docker assets are
|
||
kept separate in `docker/`.
|
||
|
||
## Install development dependencies
|
||
|
||
It is recommended to use a virtual environment to avoid conflicts with system packages (especially on Linux systems with externally managed environments).
|
||
|
||
```bash
|
||
# Create a virtual environment
|
||
python3 -m venv .venv
|
||
|
||
# Activate the virtual environment
|
||
source .venv/bin/activate # On Linux/macOS
|
||
# .venv\Scripts\activate # On Windows
|
||
|
||
# Install dependencies
|
||
pip install -r requirements.txt
|
||
pip install -e .
|
||
```
|
||
|
||
## Run the test suite
|
||
|
||
Once your virtual environment is active:
|
||
|
||
```bash
|
||
pytest
|
||
```
|
||
|
||
To gather coverage metrics:
|
||
|
||
```bash
|
||
pytest --cov=src/dolibarr_mcp --cov-report=term-missing
|
||
```
|
||
|
||
If you encounter "command not found" errors, ensure your virtual environment is activated or run via python module:
|
||
|
||
```bash
|
||
python3 -m pytest
|
||
```
|
||
|
||
## Formatting and linting
|
||
|
||
The project intentionally avoids heavy linting dependencies. Follow the coding
|
||
style already present in the repository and run the test-suite before opening a
|
||
pull request.
|
||
|
||
## Docker tooling
|
||
|
||
Container assets live in `docker/`:
|
||
|
||
- `Dockerfile` – production-ready image for the MCP server
|
||
- `docker-compose.yml` – local stack that spins up Dolibarr together with the MCP server
|
||
|
||
Build and run the container locally with:
|
||
|
||
```bash
|
||
docker compose -f docker/docker-compose.yml up --build
|
||
```
|