Metadata-Version: 2.1
Name: dmcview
Version: 0.1.0
Summary: Digital Magnatic Compass View
Home-page: https://github.com/Issamricin/dmc-view
License: AGPL-3.0-only
Keywords: digital Magnatic view,dmc
Author: Iso
Maintainer: Iso
Requires-Python: >=3.10,<3.13
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Desktop Environment
Requires-Dist: mypy (>=1.8.0,<2.0.0)
Requires-Dist: pyside6 (>=6.6.1)
Requires-Dist: pytest (>=8.0.0,<9.0.0)
Requires-Dist: pytest-cov (>=4.1.0,<5.0.0)
Requires-Dist: pytest-explicit (>=1.0.1,<2.0.0)
Requires-Dist: pytest-xdist (>=3.5.0,<4.0.0)
Requires-Dist: sphinx (>=8.1.3)
Requires-Dist: sphinx-autobuild (>=2024.10.3,<2025.0.0)
Requires-Dist: sphinx-autodoc-typehints (>=2.5.0)
Requires-Dist: sphinx-inline-tabs (>=2023.4.21,<2024.0.0) ; python_version >= "3.8" and python_version < "3.13"
Requires-Dist: sphinx-rtd-theme (>=3.0.1)
Requires-Dist: sphinxcontrib-mermaid (>=1.0.0,<2.0.0) ; python_version >= "3.7" and python_version < "3.13"
Requires-Dist: sphinxcontrib-spelling (>=8.0.0)
Project-URL: Bug Tracker, https://github.com/Issamricin/dmc-view/issues
Project-URL: CI: Github Actions, https://github.com/Issamricin/dmc-view/actions
Project-URL: Changelog, https://github.com/Issamricin/dmc-view/blob/master/CHANGELOG.rst
Project-URL: Code of Conduct, https://github.com/Issamricin/dmc-view/blob/master/CONTRIBUTING.md
Project-URL: Documentation, https://dmc-view.readthedocs.io/
Project-URL: Repository, https://github.com/Issamricin/dmc-view
Project-URL: Source Code, https://github.com/Issamricin/dmc-view
Description-Content-Type: text/x-rst

DMC VIEW

Digital Magnatic Compass View

.. start-badges

| |build| |release_version| |wheel| |supported_versions|
| |docs|
| |ruff| |gh-lic| |commits_since_specific_tag_on_main| |commits_since_latest_github_release|

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

|dmc_gif|

Features
========

1. **dmcview** `python package`

   a. View Object Azimuth, Inclindation(Elevation) and Bank; also View Declination(Offset from real North)  
   b. View animation to reflect real DMC device in 2D. Acceleration is not implemented yet 
2. Tested against Linux(ubuntu-latest) `platforms` and `python` 3.12.3
3. See `TODO <https://github.com/Issamricin/dmc-view/blob/main/TODO.rst>`_.

Technical Debt
==============
See `Technical Debt <https://github.com/Issamricin/dmc-view/blob/main/TECHNICALDEBT.rst>`_.

Change Log
==========
 `Change Log <https://github.com/Issamricin/dmc-view/blob/main/CHANGELOG.rst>`_.

How to Contribute
=================
 `Contribute <https://github.com/Issamricin/dmc-view/blob/main/CONTRIBUTING.md>`_.

Development
===========
| `Development <https://github.com/Issamricin/dmc-view/blob/main/docs/source/contents/development.rst>`_.

Quickstart
==========
| `Usage <https://github.com/Issamricin/dmc-view/blob/main/docs/source/contents/usage.rst>`_.


License
=======

|gh-lic|

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


License
=======

* Free software: GNU Affero General Public License v3.0



.. LINKS

.. _GNU Affero General Public License v3.0: https://github.com/Issamricin/dmc-view/blob/main/LICENSE


.. BADGE ALIASES

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

.. |build| image:: https://img.shields.io/github/workflow/status/Issamricin/dmc-view/Test%20Python%20Package/main?label=build&logo=github-actions&logoColor=%233392FF
    :alt: GitHub Workflow Status (branch)
    :target: https://github.com/Issamricin/dmc-view/actions/workflows/test.yaml?query=branch%3Amain


.. Documentation

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

.. PyPI

.. |release_version| image:: https://img.shields.io/pypi/v/dmcview
    :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/Issamricin/dmc-view/v0.0.1/main?color=blue&logo=github
    :alt: GitHub commits since tagged version (branch)
    :target: https://github.com/Issamricin/dmc-view/compare/v0.0.1..main

.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/Issamricin/dmc-view/latest?color=blue&logo=semver&sort=semver
    :alt: GitHub commits since latest release (by SemVer)

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

.. |gh-lic| image:: https://img.shields.io/badge/license-GNU_Affero-orange
    :alt: GitHub
    :target: https://github.com/Issamricin/dmc-view/blob/main/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/


.. Local linux command: CTRL+Shift+Alt+R key 

.. Local Image and YouTube Vedio as link
.. |dmc_image| image:: https://raw.githubusercontent.com/Issamricin/dmc-view/main/media/dmc-view.png
                :alt: DMC view which shows all the value. 2D view ; 3D view will contains 3 dimensions acceleration

.. |dmc_gif| image:: https://raw.githubusercontent.com/Issamricin/dmc-view/main/media/simulator.gif
   :alt: Demo Preview
   :width: 600

