=========================
Welcome to ooouno's docs!
=========================
|lic| |pver| |pwheel| |github|
ooouno
======
**ooouno** is a library of all *(more than 4300)* classes, typings and types for the LibreOffice `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_.
**ooouno** is for version ``2024.2`` of LibreOffice `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_.
More about `LibreOffice <https://www.libreoffice.org/>`_.
Docs
====
Read the docs `here <https://python-ooouno.readthedocs.io/>`_
Installation
============
CONDA
-----
**ooouno** on `Anaconda <https://anaconda.org/conda-forge/ooouno>`_
.. code-block:: bash
$ conda install -c conda-forge ooouno
PIP
---
**ooouno** `PyPI <https://pypi.org/project/ooouno/>`_
.. code-block:: bash
$ pip install ooouno
Usage
=====
All class found in LO `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_ are recreated in this library.
For instance:
| ``from ooo.dyn.style.line_spacing import LineSpacing`` is equivalent to
| ``from com.sun.star.style import LineSpacing``
Namespace
---------
There are four namespaces representing LO `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_ in this library.
ooo.lo
++++++
| Namespace ``ooo.lo`` contains all static python classes. The format is
| ``ooo.lo.<ns>.<snake_case_name>.<PascalCaseName>``
.. code-block:: python
from ooo.lo.uno.x_interface import XInterface
def foo(input:str) -> XInterface: ...
ooo.dyn
+++++++
Namespace ``ooo.dyn`` contains static and dynamic classes depending on class type.
The format is ``ooo.dyn.<ns>.<snake_case_name>.<PascalCaseName>``
This namespace has dynamic classes that are changed at runtime.
For classes that are dynamic are fully or partially replaced by UNO version at runtime.
This allows for typings while in design time (working in IDE) and at runtime UNO classes are created instead.
.. code-block:: python
>>> from ooo.dyn.style.line_spacing import LineSpacing as DynLineSpacing
>>> from ooo.lo.style.line_spacing import LineSpacing as LoLineSpacing
>>> dyn_lns = DynLineSpacing(Height=10, Mode=3)
>>> lo_lns = LoLineSpacing(Height=10, Mode=3)
>>> assert dyn_lns.Height == 10
>>> assert dyn_lns.Mode == 3
>>> type(dyn_lns).__name__
'com.sun.star.style.LineSpacing'
>>> type(lo_lns).__name__
'LineSpacing'
ooo.csslo
+++++++++
As of version ``2.0.0`` the ``ooo.csslo`` namespace is deprecated. Use the ``ooo.lo`` namespace instead.
| Namespace ``ooo.csslo`` contains static classes as LO `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_ style imports.
| The format is ``ooo.csslo.<ns>.<PascalCaseName>``
When importing from ``ooo.csslo`` all classes in that namespace are also loaded.
Under some circumstances this may not be desired. Such as packaging with `stickytape <https://pypi.org/project/stickytape/>`_.
.. code-block:: python
>>> from ooo.lo.style.line_spacing import LineSpacing as LoLineSpacing
>>> from ooo.csslo.style import LineSpacing as CssLineSpacing
>>> LoLineSpacing is CssLineSpacing
True
>>> ls = CssLineSpacing()
>>> type(ls).__name__
'LineSpacing'
ooo.cssdyn
++++++++++
As of version ``2.0.0`` the ``ooo.cssdyn`` namespace is deprecated. Use the ``ooo.dyn`` namespace instead.
Namespace ``ooo.cssdyn`` contains static and dynamic classes depending on class type as LO `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_ style imports.
When importing from ``ooo.cssdyn`` all classes in that namespace are also loaded.
Under some circumstances this may not be desired. Such as packaging with `stickytape <https://pypi.org/project/stickytape/>`_.
.. code-block:: python
>>> from ooo.dyn.style.line_spacing import LineSpacing as DynLineSpacing
>>> from ooo.cssdyn.style import LineSpacing as CssLineSpacing
>>> DynLineSpacing is CssLineSpacing
True
>>> ls = CssLineSpacing()
>>> type(ls).__name__
'com.sun.star.style.LineSpacing'
Generally speaking
------------------
When using ooo as typings then import from ``ooo.lo`` or ``ooo.csslo``.
When using ooo interactively such as creating struts, enums, singletons, const classes then
import from ``ooo.dyn`` or ``ooo.cssdyn``.
Development
-----------
Development environment is configured using `poetry <https://python-poetry.org/>`__.
It is recommended to install virtual environment locally.
To Configure poetry to install virtual environment in local folder:
.. code-block::
poetry config virtualenvs.in-project true
After virtual environment has been set up.
Linux/Mac
+++++++++
Link UNO files into virtual environment.
.. code-block::
oooenv cmd-link -a
Windows
+++++++
Run toggle command to set virtual environment.
.. code-block::
oooenv env -t
See Also
++++++++
- `oooenv <https://pypi.org/project/oooenv/>`__
- `OOO Development Tools - Develop Docs <https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html>`__
Related Projects
----------------
* `OOO Development Tools <https://github.com/Amourspirit/python_ooo_dev_tools>`__
* `LibreOffice API Typings <https://github.com/Amourspirit/python-types-unopy>`__
* `ScriptForge Typings <https://github.com/Amourspirit/python-types-scriptforge>`__
* `Access2base Typings <https://github.com/Amourspirit/python-types-access2base>`__
* `LibreOffice Python UNO Examples <https://github.com/Amourspirit/python-ooouno-ex>`__
* `LibreOffice Developer Search <https://github.com/Amourspirit/python_lo_dev_search>`__
* `LibreOffice UNO Typings <https://github.com/Amourspirit/python-types-uno-script>`__
* `OOO UNO TEMPLATE <https://github.com/Amourspirit/ooo_uno_tmpl>`__
.. |lic| image:: https://img.shields.io/github/license/Amourspirit/python-ooouno
:alt: License Apache
.. |pver| image:: https://img.shields.io/pypi/pyversions/ooouno
:alt: PyPI - Python Version
.. |pwheel| image:: https://img.shields.io/pypi/wheel/ooouno
:alt: PyPI - Wheel
.. |github| image:: https://img.shields.io/badge/GitHub-100000?style=plastic&logo=github&logoColor=white
:target: https://github.com/Amourspirit/python-ooouno
:alt: Github
Raw data
{
"_id": null,
"home_page": "https://github.com/Amourspirit/python-ooouno",
"name": "ooouno",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": ":Barry-Thomas-Paul: Moss",
"author_email": "vibrationoflife@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/97/2e/9d12012eac0973f5c9e27fab8ccc5adc3bdf1714f3e47f5d8b1d891dc362/ooouno-3.0.0.tar.gz",
"platform": null,
"description": "=========================\nWelcome to ooouno's docs!\n=========================\n\n|lic| |pver| |pwheel| |github|\n\nooouno\n======\n\n**ooouno** is a library of all *(more than 4300)* classes, typings and types for the LibreOffice `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_.\n\n**ooouno** is for version ``2024.2`` of LibreOffice `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_.\n\nMore about `LibreOffice <https://www.libreoffice.org/>`_.\n\nDocs\n====\n\nRead the docs `here <https://python-ooouno.readthedocs.io/>`_\n\nInstallation\n============\n\nCONDA\n-----\n\n**ooouno** on `Anaconda <https://anaconda.org/conda-forge/ooouno>`_\n\n.. code-block:: bash\n\n $ conda install -c conda-forge ooouno\n\n\nPIP\n---\n\n**ooouno** `PyPI <https://pypi.org/project/ooouno/>`_\n\n.. code-block:: bash\n\n $ pip install ooouno\n\nUsage\n=====\n\nAll class found in LO `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_ are recreated in this library.\n\nFor instance:\n | ``from ooo.dyn.style.line_spacing import LineSpacing`` is equivalent to\n | ``from com.sun.star.style import LineSpacing``\n\n\nNamespace\n---------\n\nThere are four namespaces representing LO `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_ in this library.\n\nooo.lo\n++++++\n\n| Namespace ``ooo.lo`` contains all static python classes. The format is\n| ``ooo.lo.<ns>.<snake_case_name>.<PascalCaseName>``\n\n.. code-block:: python\n\n from ooo.lo.uno.x_interface import XInterface\n\n def foo(input:str) -> XInterface: ...\n\nooo.dyn\n+++++++\n\nNamespace ``ooo.dyn`` contains static and dynamic classes depending on class type.\nThe format is ``ooo.dyn.<ns>.<snake_case_name>.<PascalCaseName>``\n\nThis namespace has dynamic classes that are changed at runtime.\nFor classes that are dynamic are fully or partially replaced by UNO version at runtime.\n\nThis allows for typings while in design time (working in IDE) and at runtime UNO classes are created instead.\n\n.. code-block:: python\n\n >>> from ooo.dyn.style.line_spacing import LineSpacing as DynLineSpacing\n >>> from ooo.lo.style.line_spacing import LineSpacing as LoLineSpacing\n >>> dyn_lns = DynLineSpacing(Height=10, Mode=3)\n >>> lo_lns = LoLineSpacing(Height=10, Mode=3)\n >>> assert dyn_lns.Height == 10\n >>> assert dyn_lns.Mode == 3\n >>> type(dyn_lns).__name__\n 'com.sun.star.style.LineSpacing'\n >>> type(lo_lns).__name__\n 'LineSpacing'\n \n\nooo.csslo\n+++++++++\n\nAs of version ``2.0.0`` the ``ooo.csslo`` namespace is deprecated. Use the ``ooo.lo`` namespace instead.\n\n| Namespace ``ooo.csslo`` contains static classes as LO `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_ style imports.\n| The format is ``ooo.csslo.<ns>.<PascalCaseName>``\n\nWhen importing from ``ooo.csslo`` all classes in that namespace are also loaded.\nUnder some circumstances this may not be desired. Such as packaging with `stickytape <https://pypi.org/project/stickytape/>`_.\n\n.. code-block:: python\n\n >>> from ooo.lo.style.line_spacing import LineSpacing as LoLineSpacing\n >>> from ooo.csslo.style import LineSpacing as CssLineSpacing\n >>> LoLineSpacing is CssLineSpacing\n True\n >>> ls = CssLineSpacing()\n >>> type(ls).__name__\n 'LineSpacing'\n\nooo.cssdyn\n++++++++++\n\nAs of version ``2.0.0`` the ``ooo.cssdyn`` namespace is deprecated. Use the ``ooo.dyn`` namespace instead.\n\nNamespace ``ooo.cssdyn`` contains static and dynamic classes depending on class type as LO `API <https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html>`_ style imports.\n\nWhen importing from ``ooo.cssdyn`` all classes in that namespace are also loaded.\nUnder some circumstances this may not be desired. Such as packaging with `stickytape <https://pypi.org/project/stickytape/>`_.\n\n.. code-block:: python\n\n >>> from ooo.dyn.style.line_spacing import LineSpacing as DynLineSpacing\n >>> from ooo.cssdyn.style import LineSpacing as CssLineSpacing\n >>> DynLineSpacing is CssLineSpacing\n True\n >>> ls = CssLineSpacing()\n >>> type(ls).__name__\n 'com.sun.star.style.LineSpacing'\n\n\nGenerally speaking\n------------------\n\nWhen using ooo as typings then import from ``ooo.lo`` or ``ooo.csslo``.\n\nWhen using ooo interactively such as creating struts, enums, singletons, const classes then\nimport from ``ooo.dyn`` or ``ooo.cssdyn``.\n\nDevelopment\n-----------\n\nDevelopment environment is configured using `poetry <https://python-poetry.org/>`__.\n\nIt is recommended to install virtual environment locally.\n\nTo Configure poetry to install virtual environment in local folder:\n\n.. code-block::\n\n poetry config virtualenvs.in-project true\n\nAfter virtual environment has been set up.\n\nLinux/Mac\n+++++++++\n\nLink UNO files into virtual environment.\n\n.. code-block::\n\n oooenv cmd-link -a\n\nWindows\n+++++++\n\nRun toggle command to set virtual environment.\n\n.. code-block::\n\n oooenv env -t\n\nSee Also\n++++++++\n\n- `oooenv <https://pypi.org/project/oooenv/>`__\n- `OOO Development Tools - Develop Docs <https://python-ooo-dev-tools.readthedocs.io/en/latest/dev_docs/dev_notes.html>`__\n\nRelated Projects\n----------------\n\n* `OOO Development Tools <https://github.com/Amourspirit/python_ooo_dev_tools>`__\n* `LibreOffice API Typings <https://github.com/Amourspirit/python-types-unopy>`__\n* `ScriptForge Typings <https://github.com/Amourspirit/python-types-scriptforge>`__\n* `Access2base Typings <https://github.com/Amourspirit/python-types-access2base>`__\n* `LibreOffice Python UNO Examples <https://github.com/Amourspirit/python-ooouno-ex>`__\n* `LibreOffice Developer Search <https://github.com/Amourspirit/python_lo_dev_search>`__\n* `LibreOffice UNO Typings <https://github.com/Amourspirit/python-types-uno-script>`__\n* `OOO UNO TEMPLATE <https://github.com/Amourspirit/ooo_uno_tmpl>`__\n\n.. |lic| image:: https://img.shields.io/github/license/Amourspirit/python-ooouno\n :alt: License Apache\n\n.. |pver| image:: https://img.shields.io/pypi/pyversions/ooouno\n :alt: PyPI - Python Version\n\n.. |pwheel| image:: https://img.shields.io/pypi/wheel/ooouno\n :alt: PyPI - Wheel\n\n.. |github| image:: https://img.shields.io/badge/GitHub-100000?style=plastic&logo=github&logoColor=white\n :target: https://github.com/Amourspirit/python-ooouno\n :alt: Github\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Interfaces and classes for LibreOffice (uno)",
"version": "3.0.0",
"project_urls": {
"Documentation": "https://github.com/Amourspirit/python-ooouno",
"Homepage": "https://github.com/Amourspirit/python-ooouno",
"Repository": "https://github.com/Amourspirit/python-ooouno"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f93dd7f5f71958020e945f5a9c2923fc5d4f473d5ab92af4c61eb09f8014dc45",
"md5": "f0f25e5e0fa4c870d34b3de6a3f70bf3",
"sha256": "237af5c39c41892e00dacb7d89c18b62025af080c96579bb3c24051f0113fd65"
},
"downloads": -1,
"filename": "ooouno-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f0f25e5e0fa4c870d34b3de6a3f70bf3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 9864269,
"upload_time": "2024-08-31T23:12:36",
"upload_time_iso_8601": "2024-08-31T23:12:36.243731Z",
"url": "https://files.pythonhosted.org/packages/f9/3d/d7f5f71958020e945f5a9c2923fc5d4f473d5ab92af4c61eb09f8014dc45/ooouno-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "972e9d12012eac0973f5c9e27fab8ccc5adc3bdf1714f3e47f5d8b1d891dc362",
"md5": "4d012237c31f42973efd7342bf1cf780",
"sha256": "e4b4208387bda46c2ba777f9e406fba22d1eb4367d0ec56403f4fc23bb50d580"
},
"downloads": -1,
"filename": "ooouno-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4d012237c31f42973efd7342bf1cf780",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 2225207,
"upload_time": "2024-08-31T23:12:43",
"upload_time_iso_8601": "2024-08-31T23:12:43.583014Z",
"url": "https://files.pythonhosted.org/packages/97/2e/9d12012eac0973f5c9e27fab8ccc5adc3bdf1714f3e47f5d8b1d891dc362/ooouno-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 23:12:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Amourspirit",
"github_project": "python-ooouno",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ooouno"
}
JSON
