Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request. I would like to keep the library to be safe as possible, so i would appreciate if you cover any new feature with tests to maintain 100% coverage.

Install in a development environment

1. First, clone the repository:

   git clone git@github.com:SpaceShaman/socketapi.git
   

2. Install uv if you don't have it:

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

3. Create a virtual environment and install the dependencies:

   cd socketapi
   uv sync
   

Run tests

You can run the tests with the following command:

uv run pytest

You can also run the tests with coverage:

uv run pytest --cov=socketapi