Metadata-Version: 2.4
Name: dmc-view
Version: 0.3.4
Summary: Digital Magnetic Compass View
License: AGPL-3.0-only
License-File: AUTHORS.md
License-File: LICENSE
Keywords: digital magnetic view,dmc
Author: Iso
Maintainer: Iso
Requires-Python: >=3.13
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Desktop Environment
Provides-Extra: docs
Provides-Extra: test
Requires-Dist: Sphinx (<=8.2.3) ; (python_version >= "3.11" and python_version <= "3.14") and (extra == "docs")
Requires-Dist: matplotlib (>=3.10.1) ; python_version >= "3.10" and python_version <= "3.13"
Requires-Dist: pyside6 (<=6.11.2) ; python_version < "3.15" and python_version >= "3.10"
Requires-Dist: pytest (>=8.4.0) ; (python_version >= "3.9" and python_version <= "3.14") and (extra == "test")
Requires-Dist: pytest-cov (>=6) ; (python_version >= "3.9" and python_version <= "3.13") and (extra == "test")
Requires-Dist: pytest-mock (>=3.14.0) ; (python_version >= "3.9" and python_version <= "3.14") and (extra == "test")
Requires-Dist: pytest-qt (>=4.5.0) ; (python_version >= "3.9" and python_version <= "3.13") and (extra == "test")
Requires-Dist: sphinx-autobuild (==2024.10.3) ; (python_version >= "3.9" and python_version <= "3.14") and (extra == "docs")
Requires-Dist: sphinx-autodoc-typehints (<=3.2.0) ; (python_version >= "3.11" and python_version <= "3.14") and (extra == "docs")
Requires-Dist: sphinx-inline-tabs (==2023.4.21) ; (python_version >= "3.8" and python_version <= "3.14") and (extra == "docs")
Requires-Dist: sphinx-rtd-theme (<=3.0.2) ; (python_version >= "3.8" and python_version <= "3.14") and (extra == "docs")
Requires-Dist: sphinxcontrib-mermaid (<=1.0.0) ; (python_version >= "3.8" and python_version <= "3.14") and (extra == "docs")
Requires-Dist: sphinxcontrib-spelling (<=8.0.1) ; (python_version >= "3.10" and python_version <= "3.14") and (extra == "docs")
Project-URL: Bug Tracker, https://github.com/iso-techdev/dmc-view/issues
Project-URL: CI: Github Actions, https://github.com/iso-techdev/dmc-view/actions
Project-URL: Changelog, https://github.com/iso-techdev/dmc-view/blob/master/CHANGELOG.rst
Project-URL: Code of Conduct, https://github.com/iso-techdev/dmc-view/blob/master/CONTRIBUTING.md
Project-URL: Documentation, https://dmc-view.readthedocs.io/
Project-URL: Source Code, https://github.com/iso-techdev/dmc-view
Description-Content-Type: text/x-rst

| **Digital Magnetic Compass View**

.. image:: https://raw.githubusercontent.com/iso-techdev/dmc-view/master/media/logo.png
   :alt: Digital Magnatic Compass View 
   :height: 200

COMMUNITY VERSION
-----------------

.. start-badges see https://shields.io/badges and collection see https://github.com/inttter/md-badges

| |build| |release_version| |wheel| 
| |docs| |pylint| |supported_versions|
| |ruff| |gh-lic| |commits_since_specific_tag_on_main|
| |codacy| |coveralls|


|
| **Code:** https://github.com/iso-techdev/dmc-view
| **Docs:** https://dmc-view.readthedocs.io/en/latest/
| **PyPI:** https://pypi.org/project/dmc-view/
| **CI:** https://github.com/iso-techdev/dmc-view/actions/
  
|
|
|

|dmc_gif|

Features
========

1. **dmcview** `python package`

   a. View Object Azimuth, Inclindation(Elevation), Bank, Declination(Offset from real North), and Acceleration 
   b. View animation to reflect real DMC device in 2D
   c. View acceleration in 3D
2. Tested against Linux(ubuntu-latest) `platforms` and `python` 3.13
3. `TODO <https://github.com/iso-techdev/dmc-view/blob/master/TODO.rst>`_

Technical Debt
==============
`Technical Debt <https://github.com/iso-techdev/dmc-view/blob/master/TECHNICALDEBT.rst>`_

Change Log
==========
`Change Log <https://github.com/iso-techdev/dmc-view/blob/master/CHANGELOG.rst>`_.


Developer Guide
===============
`Development <https://github.com/iso-techdev/dmc-view/blob/master/docs/source/contents/development.rst>`_

Quickstart
==========
`Usage <https://github.com/iso-techdev/dmc-view/blob/master/docs/source/contents/usage.rst>`_


License
=======
`GNU Affero General Public License v3.0`_



.. LINKS

.. _GNU Affero General Public License v3.0: https://github.com/iso-techdev/dmc-view/blob/master/LICENSE

 

.. BADGE ALIASES

.. Build Status
.. Github Actions: Test Workflow Status for specific branch <branch>

.. |build| image:: https://github.com/iso-techdev/dmc-view/actions/workflows/ci_cd.yaml/badge.svg
    :alt: GitHub Workflow Status (branch)
    :target: https://github.com/iso-techdev/dmc-view/actions/


.. Documentation

.. |docs| image:: https://img.shields.io/readthedocs/dmc-view/latest?logo=readthedocs&logoColor=lightblue
    :alt: Read the Docs (version)
    :target: https://dmc-view.readthedocs.io/en/latest/

.. |pylint| image:: https://img.shields.io/badge/linting-pylint-yellowgreen
    :target: https://github.com/pylint-dev/pylint

.. PyPI

.. |release_version| image:: https://img.shields.io/pypi/v/dmc-view
    :alt: Production Version
    :target: https://pypi.org/project/dmc-view/

.. |wheel| image:: https://img.shields.io/pypi/wheel/dmc-view?color=green&label=wheel
    :alt: PyPI - Wheel
    :target: https://pypi.org/project/dmc-view

.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/dmc-view?color=blue&label=python&logo=python&logoColor=%23ccccff
    :alt: Supported Python versions
    :target: https://pypi.org/project/dmc-view

.. Github Releases & Tags

.. |commits_since_specific_tag_on_main| image:: https://img.shields.io/github/commits-since/iso-techdev/dmc-view/v0.0.1/master?color=blue&logo=github
    :alt: GitHub commits since tagged version (branch)
    :target: https://github.com/iso-techdev/dmc-view/compare/v0.0.1..master

.. LICENSE (eg AGPL, MIT)
.. Github License

.. |gh-lic| image:: https://img.shields.io/badge/license-GNU_Affero-orange
    :alt: GitHub
    :target: https://github.com/iso-techdev/dmc-view/blob/master/LICENSE


.. Ruff linter for Fast Python Linting

.. |ruff| image:: https://img.shields.io/badge/codestyle-ruff-000000.svg
    :alt: Ruff
    :target: https://docs.astral.sh/ruff/


.. |codacy| image:: https://app.codacy.com/project/badge/Grade/9d883627ff974ff9a6721700c2909ac1
    :alt: Codacy
    :target: https://app.codacy.com/gh/iso-techdev/dmc-view/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade

.. |coveralls| image:: https://coveralls.io/repos/github/iso-techdev/dmc-view/badge.svg?branch=master
    :alt: Coveralls
    :target: https://coveralls.io/github/iso-techdev/dmc-view?branch=master

.. Local Image as link

.. |dmc_gif| image:: https://raw.githubusercontent.com/iso-techdev/dmc-view/master/media/simulator.gif
   :alt: Demo Preview
   :width: 800
   :height: 391



