pyzwoasi 0.2.0

Python binding for the ZWO ASI SDK library

PyZWOASI ·

PyZWOASI is a Python binding for the ZWO ASI SDK. It is developped to be easy-to-use and functional, and, if I can make it, up-to-date.

Currently compatible with Windows, Linux and MacOS.

   

Installation

The safest and simplest way to install pyzwoasi is to use its repository from PyPI using pip :

python -m pip install --upgrade pip
python -m pip install pyzwoasi

The installer will take in charge the machine configuration and choose the right compiled library file from ZWO. You will not have useless .dll files on your machine, only the needed ones.

Roadmap

^{Current number of supported ASI SDK v1.37 features: 40/43}

• Add Linux support
• Add MacOS support
• Add Android support
• Add more precise error handling
• Add missing functions from the ZWO ASI SDK
  • Add function ASIGetVideoDataGPS
  • Add function ASIGetDataAfterExpGPS
  • Add function ASIGPSGetData

If you have any wishes, suggestions, comments or advice, please feel free to create an issue or contact me directly.

Code quality

This Python project will also be a test of different codings metrics and tools to ensure its quality and security. This part is more a personal challenge and journey into new metrics and Python tools.

• Computing code coverage using coverage
• Static code analysis using pylint
• Style guide enforcement using black or flake8
• Writing a Git best practices charter for the project (atomic commits and explicits like feat:, fix:, refactor: and so on. More about this about here and here)
• Writing a security charter, using bandit and safety to ensure the code is secure
• Making large documentation using sphinx, readthedocs and proposing metrics with docstr-coverage
• Profiling the code with cProfile and line_profiler
• Various other code metrics with radon and mccabe
• Adding build status badges and SonarQube badges
• and lots of other things proposed by other repos

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contributors

Contact

François Margall - [e-mail]