Skip to main content

Python API for acquisition and control of Alicat mass flow meters and controllers.

Project description

pyAlicat

pyAlicat

Build status Python Version Dependencies Status

Code style: black Security: bandit Pre-commit Semantic Versions License Coverage Report

Python API for acquisition and control of Alicat mass flow meters and controllers.

See Alicat Serial Communications Guide for reference

Installation

pip install -U pyAlicat

or install with Poetry

poetry add pyAlicat

Makefile usage

Makefile contains a lot of functions for faster development.

1. Download and remove Poetry

To download and install Poetry run:

make poetry-download

To uninstall

make poetry-remove

2. Install all dependencies and pre-commit hooks

Install requirements:

make install

Pre-commit hooks coulb be installed after git init via

make pre-commit-install

3. Codestyle

Automatic formatting uses pyupgrade, isort and black.

make codestyle

# or use synonym
make formatting

Codestyle checks only, without rewriting files:

make check-codestyle

Note: check-codestyle uses isort, black and darglint library

Update all dev libraries to the latest version using one comand

make update-dev-deps
4. Code security

make check-safety

This command launches Poetry integrity checks as well as identifies security issues with Safety and Bandit.

make check-safety

5. Type checks

Run mypy static type checker

make mypy

6. Tests with coverage badges

Run pytest

make test

7. All linters

Of course there is a command to rule run all linters in one:

make lint

the same as:

make test && make check-codestyle && make mypy && make check-safety

8. Docker

make docker-build

which is equivalent to:

make docker-build VERSION=latest

Remove docker image with

make docker-remove

More information about docker.

9. Cleanup

Delete pycache files

make pycache-remove

Remove package build

make build-remove

Delete .DS_STORE files

make dsstore-remove

Remove .mypycache

make mypycache-remove

Or to remove all above run:

make cleanup

📈 Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification.

We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

List of labels and corresponding titles

Label Title in Releases
enhancement, feature 🚀 Features
bug, refactoring, bugfix, fix 🔧 Fixes & Refactoring
build, ci, testing 📦 Build System & CI/CD
breaking 💥 Breaking Changes
documentation 📝 Documentation
dependencies ⬆️ Dependencies updates

You can update it in release-drafter.yml.

GitHub creates the bug, enhancement, and documentation labels for you. Dependabot creates the dependencies label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.

🛡 License

License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

📃 Citation

@misc{pyAlicat,
  author = {ulfsri},
  title = {Python API for acquisition and control of Alicat mass flow meters and controllers},
  year = {2024},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/ulfsri/pyAlicat}}
}

Credits 🚀 Your next Python package needs a bleeding-edge project structure.

This project was generated with python-package-template

Logo design by Natalya England

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyalicat-0.0.11.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

pyalicat-0.0.11-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

Details for the file pyalicat-0.0.11.tar.gz.

File metadata

  • Download URL: pyalicat-0.0.11.tar.gz
  • Upload date:
  • Size: 31.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.11-300.fc40.x86_64

File hashes

Hashes for pyalicat-0.0.11.tar.gz
Algorithm Hash digest
SHA256 a7cc6feacaa32fd23e866c7fd0a9e6a8cc29fb2acf270d6ca8f671b872716e92
MD5 658ee64dd7969521dd57369e99da3fa9
BLAKE2b-256 7bc541858e7a06c7636b31e865bff5a03f68e7fe588a45f57370c7b1faf3dd33

See more details on using hashes here.

File details

Details for the file pyalicat-0.0.11-py3-none-any.whl.

File metadata

  • Download URL: pyalicat-0.0.11-py3-none-any.whl
  • Upload date:
  • Size: 29.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.11-300.fc40.x86_64

File hashes

Hashes for pyalicat-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 4d3ee0e6ffad52916848bacea1f98f470564e99c59b90323d639bdb41b59c83f
MD5 9316de8681340628d23083195f69d437
BLAKE2b-256 89211275f7b01b3888118f0f03c05ce3dcc0cbc277efd49388664011a3ea836c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page