### Clone the repository and install the package Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Commands to clone the project repository, navigate into it, and install the package in editable mode. ```bash git clone git@github.com:YourLogin/meshctrl.git cd meshctrl pip install -U pip setuptools -e . ``` -------------------------------- ### Creating a Dedicated Virtual Environment for Tox Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Steps to create a dedicated virtual environment and install tox for troubleshooting. ```bash virtualenv .venv ``` ```bash source .venv/bin/activate ``` ```bash .venv/bin/pip install tox ``` ```bash .venv/bin/tox -e all ``` -------------------------------- ### Recreating Tox Environment Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Example of how to recreate a tox environment with the -r flag when dependencies are missing. ```bash tox -e docs ``` ```bash tox -r -e docs ``` -------------------------------- ### Checking Tox Version and Location Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Commands to check the installed tox version and its location. ```bash tox --version ``` ```bash which tox ``` -------------------------------- ### Running Pytest with PDB Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Example of running a pytest command with the --pdb option to drop into an interactive session on failure. ```bash tox -- -k --pdb ``` -------------------------------- ### Compile and preview documentation locally Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Commands to compile documentation using tox and preview it using Python's http.server. ```bash tox -e docs python3 -m http.server --directory 'docs/_build/html' ``` -------------------------------- ### Async Context Manager Usage Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/README.rst Demonstrates the preferred way to initialize and use the Session class with an asynchronous context manager. ```python import meshctrl async with meshctrl.Session(url, **options): print(await session.list_users()) ... ``` -------------------------------- ### Manual Session Initialization Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/README.rst Shows how to manually instantiate the Session object and wait for its initialization. ```python session = meshctrl.Session(url, **options) await session.initialized.wait() ``` -------------------------------- ### Project Dependencies Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/requirements.txt This file lists the Python packages required for the pylibmeshctrl project. ```text cryptography ~ = 46.0.5 websockets ~ = 16.0.0 python-socks[asyncio] ~ = 2.8.1 ``` -------------------------------- ### Create and activate a virtual environment Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Commands to create an isolated virtual environment using venv and activate it. ```bash python -m venv source /bin/activate ``` -------------------------------- ### Stage and commit changes Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Commands to stage modified files and commit them using git. ```bash git add git commit ``` -------------------------------- ### Create a feature branch Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Command to create a new git branch for feature development. ```bash git checkout -b my-feature ``` -------------------------------- ### Push feature branch to remote repository Source: https://github.com/huflungdu/pylibmeshctrl/blob/main/CONTRIBUTING.rst Command to push the local feature branch to the remote repository. ```bash git push -u origin my-feature ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.