server

Guides

This section contains guides for using and developing the Makefile Command Runner.

Table of Contents

• Getting Started
• Development Workflow
• Testing
• Deployment
• Troubleshooting

Getting Started

Prerequisites

• Python 3.10 or later
• make
• pip (Python package manager)
• Git (for development)

Installation

1. Clone the repository:

   git clone <repository-url>
   cd makefile-command-runner
   

2. Set up the virtual environment:

   make venv
   

3. Install development dependencies:

   pip install -r dev-requirements.txt
   

Development Workflow

Code Style

This project uses:

• Black for code formatting
• Flake8 for linting
• isort for import sorting
• mypy for type checking

Run the following commands before committing:

black .
isort .
flake8 .
mypy .

Pre-commit Hooks

Install pre-commit hooks:

pre-commit install

Testing

Run the test suite:

make test

Or run specific tests:

pytest tests/unit/test_http_server.py -v

Deployment

Building the Package

python setup.py sdist bdist_wheel

Publishing

1. Build the package
2. Upload to PyPI:

   twine upload dist/*
   

Troubleshooting

Common Issues

gRPC Connection Issues

If you encounter connection issues with the gRPC server:

1. Verify the server is running
2. Check the port number (default: 50051)
3. Ensure no firewall is blocking the connection

Python Version Mismatch

Ensure you’re using Python 3.10 or later. Check with:

python --version

Getting Help

If you encounter issues not covered in this guide:

1. Check the issue tracker
2. Open a new issue if your problem isn’t reported

This site is open source. Improve this page.