pysesameos2

https://pysesameos2.readthedocs.io/
Admin
pysesameos2 is an unofficial Python library designed to communicate with and control SESAME OS2...
Tokens:2,371
Snippets:36
Trust Score:9.6
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install dependencies and start virtualenv with poetry

Source: https://pysesameos2.readthedocs.io/en/latest/contributing

Install dependencies and start your virtualenv. Requires poetry to be installed. The -E doc flag installs the documentation extras.

```shell
$ poetry install -E doc

```

--------------------------------

### Install pysesameos2 with pip

Source: https://pysesameos2.readthedocs.io/en/latest/installation

Installs the latest stable release of pysesameos2 from PyPI using pip.

```bash
$ pip install pysesameos2

```

--------------------------------

### Install pre-commit hooks

Source: https://pysesameos2.readthedocs.io/en/latest/contributing

Set up pre-commit hooks for automatic code formatting and linting.

```shell
$ pre-commit install

```

--------------------------------

### Install dependencies with Poetry

Source: https://pysesameos2.readthedocs.io/en/latest/installation

Installs the project dependencies using Poetry, excluding development dependencies.

```bash
$ poetry install --no-dev

```

--------------------------------

### Deploy to PyPI with bump2version

Source: https://pysesameos2.readthedocs.io/en/latest/contributing

Deployment command sequence for maintainers. Requires all changes committed including an entry in HISTORY.md. Possible versions are major, minor, or patch.

```shell
$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

```

--------------------------------

### Create a branch for local development

Source: https://pysesameos2.readthedocs.io/en/latest/contributing

Create a branch for local development. Replace name-of-your-bugfix-or-feature with a descriptive branch name.

```shell
$ git checkout -b name-of-your-bugfix-or-feature

```

--------------------------------

### Clone the forked pysesameos2 repository

Source: https://pysesameos2.readthedocs.io/en/latest/contributing

Clone your fork of the pysesameos2 repo on GitHub. Replace your_name_here with your GitHub username.

```shell
$ git clone git@github.com:your_name_here/pysesameos2.git

```

--------------------------------

### Invoke pre-commit manually

Source: https://pysesameos2.readthedocs.io/en/latest/contributing

Run the pre-commit hook manually.

```shell
$ pre-commit run

```

--------------------------------

### Commit changes and push branch

Source: https://pysesameos2.readthedocs.io/en/latest/contributing

Stage all changes, commit with a descriptive message, and push the branch to GitHub. Replace name-of-your-bugfix-or-feature with your branch name.

```shell
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

```

--------------------------------

### Run tests with tox

Source: https://pysesameos2.readthedocs.io/en/latest/contributing

Run tests, including testing other Python versions, using tox. This checks that changes pass for supported Python versions.

```shell
$ tox

```

--------------------------------

### Clone pysesameos2 repository

Source: https://pysesameos2.readthedocs.io/en/latest/installation

Clones the pysesameos2 repository from GitHub to obtain the source code.

```bash
$ git clone git://github.com/mochipon/pysesameos2

```

--------------------------------

### Download pysesameos2 tarball

Source: https://pysesameos2.readthedocs.io/en/latest/installation

Downloads the source code tarball of pysesameos2 from GitHub.

```bash
$ curl -OJL https://github.com/mochipon/pysesameos2/tarball/master

```

--------------------------------

### Run a subset of tests with pytest

Source: https://pysesameos2.readthedocs.io/en/latest/contributing

Run a subset of tests by specifying the test module or test case.

```shell
$ pytest tests.test_pysesameos2

```
Tokens:
Raw