| Name | matricity JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Embedded domain-specific library for implicitly and explicitly encoding functions as matrices that operate on domains of one-hot vectors. |
| upload_time | 2024-12-31 09:46:48 |
| maintainer | None |
| docs_url | None |
| author | Andrei Lapets |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=========
matricity
=========
Embedded domain-specific library for implicitly and explicitly encoding functions as matrices that operate on domains of one-hot vectors.
|pypi| |readthedocs| |actions| |coveralls|
.. |pypi| image:: https://badge.fury.io/py/matricity.svg#
:target: https://badge.fury.io/py/matricity
:alt: PyPI version and link.
.. |readthedocs| image:: https://readthedocs.org/projects/matricity/badge/?version=latest
:target: https://matricity.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs documentation status.
.. |actions| image:: https://github.com/reity/matricity/workflows/lint-test-cover-docs/badge.svg#
:target: https://github.com/reity/matricity/actions/workflows/lint-test-cover-docs.yml
:alt: GitHub Actions status.
.. |coveralls| image:: https://coveralls.io/repos/github/reity/matricity/badge.svg?branch=main
:target: https://coveralls.io/github/reity/matricity?branch=main
:alt: Coveralls test coverage summary.
Purpose
-------
This embedded domain-specific language (EDSL) makes it possible to define domains of values that can be automatically converted to and from their `one-hot <https://en.wikipedia.org/wiki/One-hot>`__ vector representations and to use any appropriately annotated function as a `binary matrix <https://en.wikipedia.org/wiki/Binary_matrix>`__ that can be applied to a one-hot vector representation of a value. Additional background information and examples can be found in a `relevant report <https://eprint.iacr.org/2024/2088>`__.
Installation and Usage
----------------------
This library is available as a `package on PyPI <https://pypi.org/project/matricity>`__:
.. code-block:: bash
python -m pip install matricity
The library can be imported in the usual ways:
.. code-block:: python
import matricity
from matricity import *
Development
-----------
All installation and development dependencies are fully specified in ``pyproject.toml``. The ``project.optional-dependencies`` object is used to `specify optional requirements <https://peps.python.org/pep-0621>`__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip <https://pypi.org/project/pip>`__:
.. code-block:: bash
python -m pip install ".[docs,lint]"
Documentation
^^^^^^^^^^^^^
The documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__:
.. code-block:: bash
python -m pip install ".[docs]"
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html
Testing and Conventions
^^^^^^^^^^^^^^^^^^^^^^^
All unit tests are executed and their coverage is measured when using `pytest <https://docs.pytest.org>`__ (see the ``pyproject.toml`` file for configuration details):
.. code-block:: bash
python -m pip install ".[test]"
python -m pytest
Alternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`__:
.. code-block:: bash
python src/matricity/matricity.py -v
Style conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:
.. code-block:: bash
python -m pip install ".[lint]"
python -m pylint src/matricity
Contributions
^^^^^^^^^^^^^
In order to contribute to the source code, open an issue or submit a pull request on the `GitHub page <https://github.com/reity/matricity>`__ for this library.
Versioning
^^^^^^^^^^
The version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 <https://semver.org/#semantic-versioning-200>`__.
Publishing
^^^^^^^^^^
This library can be published as a `package on PyPI <https://pypi.org/project/matricity>`__ via the GitHub Actions workflow found in ``.github/workflows/build-publish-sign-release.yml`` that follows the `recommendations found in the Python Packaging User Guide <https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/>`__.
Ensure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions.
To publish the package, create and push a tag for the version being published (replacing ``?.?.?`` with the version number):
.. code-block:: bash
git tag ?.?.?
git push origin ?.?.?
Raw data
{
"_id": null,
"home_page": null,
"name": "matricity",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Andrei Lapets",
"author_email": "a@lapets.io",
"download_url": "https://files.pythonhosted.org/packages/7a/22/710a3865db97e20fa548466c870a2a42b5d910a08c42295c1df04baaf881/matricity-0.1.0.tar.gz",
"platform": null,
"description": "=========\nmatricity\n=========\n\nEmbedded domain-specific library for implicitly and explicitly encoding functions as matrices that operate on domains of one-hot vectors.\n\n|pypi| |readthedocs| |actions| |coveralls|\n\n.. |pypi| image:: https://badge.fury.io/py/matricity.svg#\n :target: https://badge.fury.io/py/matricity\n :alt: PyPI version and link.\n\n.. |readthedocs| image:: https://readthedocs.org/projects/matricity/badge/?version=latest\n :target: https://matricity.readthedocs.io/en/latest/?badge=latest\n :alt: Read the Docs documentation status.\n\n.. |actions| image:: https://github.com/reity/matricity/workflows/lint-test-cover-docs/badge.svg#\n :target: https://github.com/reity/matricity/actions/workflows/lint-test-cover-docs.yml\n :alt: GitHub Actions status.\n\n.. |coveralls| image:: https://coveralls.io/repos/github/reity/matricity/badge.svg?branch=main\n :target: https://coveralls.io/github/reity/matricity?branch=main\n :alt: Coveralls test coverage summary.\n\nPurpose\n-------\nThis embedded domain-specific language (EDSL) makes it possible to define domains of values that can be automatically converted to and from their `one-hot <https://en.wikipedia.org/wiki/One-hot>`__ vector representations and to use any appropriately annotated function as a `binary matrix <https://en.wikipedia.org/wiki/Binary_matrix>`__ that can be applied to a one-hot vector representation of a value. Additional background information and examples can be found in a `relevant report <https://eprint.iacr.org/2024/2088>`__.\n\nInstallation and Usage\n----------------------\nThis library is available as a `package on PyPI <https://pypi.org/project/matricity>`__:\n\n.. code-block:: bash\n\n python -m pip install matricity\n\nThe library can be imported in the usual ways:\n\n.. code-block:: python\n\n import matricity\n from matricity import *\n\nDevelopment\n-----------\nAll installation and development dependencies are fully specified in ``pyproject.toml``. The ``project.optional-dependencies`` object is used to `specify optional requirements <https://peps.python.org/pep-0621>`__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip <https://pypi.org/project/pip>`__:\n\n.. code-block:: bash\n\n python -m pip install \".[docs,lint]\"\n\nDocumentation\n^^^^^^^^^^^^^\nThe documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__:\n\n.. code-block:: bash\n\n python -m pip install \".[docs]\"\n cd docs\n sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html\n\nTesting and Conventions\n^^^^^^^^^^^^^^^^^^^^^^^\nAll unit tests are executed and their coverage is measured when using `pytest <https://docs.pytest.org>`__ (see the ``pyproject.toml`` file for configuration details):\n\n.. code-block:: bash\n\n python -m pip install \".[test]\"\n python -m pytest\n\nAlternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`__:\n\n.. code-block:: bash\n\n python src/matricity/matricity.py -v\n\nStyle conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:\n\n.. code-block:: bash\n\n python -m pip install \".[lint]\"\n python -m pylint src/matricity\n\nContributions\n^^^^^^^^^^^^^\nIn order to contribute to the source code, open an issue or submit a pull request on the `GitHub page <https://github.com/reity/matricity>`__ for this library.\n\nVersioning\n^^^^^^^^^^\nThe version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 <https://semver.org/#semantic-versioning-200>`__.\n\nPublishing\n^^^^^^^^^^\nThis library can be published as a `package on PyPI <https://pypi.org/project/matricity>`__ via the GitHub Actions workflow found in ``.github/workflows/build-publish-sign-release.yml`` that follows the `recommendations found in the Python Packaging User Guide <https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/>`__.\n\nEnsure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions.\n\nTo publish the package, create and push a tag for the version being published (replacing ``?.?.?`` with the version number):\n\n.. code-block:: bash\n\n git tag ?.?.?\n git push origin ?.?.?\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Embedded domain-specific library for implicitly and explicitly encoding functions as matrices that operate on domains of one-hot vectors.",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://matricity.readthedocs.io",
"Repository": "https://github.com/reity/matricity"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eba6a4689b47b812c050b8ba76c980c0a3b24d74e41445c13412210024df032d",
"md5": "f227feb3eae118ed399cacad9dc5f666",
"sha256": "fdb261f1f22dbe06241cfb64bcc3309929391407ef0ce93e688fe67fd0259995"
},
"downloads": -1,
"filename": "matricity-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f227feb3eae118ed399cacad9dc5f666",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6409,
"upload_time": "2024-12-31T09:46:46",
"upload_time_iso_8601": "2024-12-31T09:46:46.396678Z",
"url": "https://files.pythonhosted.org/packages/eb/a6/a4689b47b812c050b8ba76c980c0a3b24d74e41445c13412210024df032d/matricity-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a22710a3865db97e20fa548466c870a2a42b5d910a08c42295c1df04baaf881",
"md5": "3542f350ffb0f50ea36e7db9d3861e85",
"sha256": "974cc72417edf9d2cf3134206bfb3f84e5c877239370a4761eb56dabcfaebcb9"
},
"downloads": -1,
"filename": "matricity-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3542f350ffb0f50ea36e7db9d3861e85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6561,
"upload_time": "2024-12-31T09:46:48",
"upload_time_iso_8601": "2024-12-31T09:46:48.994762Z",
"url": "https://files.pythonhosted.org/packages/7a/22/710a3865db97e20fa548466c870a2a42b5d910a08c42295c1df04baaf881/matricity-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-31 09:46:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "reity",
"github_project": "matricity",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "matricity"
}
