===================
ScriptForge Typings
===================
This project is Type Support (typings) for LibreOffice `ScriptForge <https://gitlab.com/LibreOfficiant/scriptforge>`_
At the time of this writing there is no other PyPi package for ScriptForge.
It is not necessary to have a ScriptForge package to take advantage of
ScriptForge Typings.
ScriptForge lives inside of LibreOffice. Using these typings in a modern development IDE
will give type Support for the ScriptForge library.
This project leverages `types-unopy <https://github.com/Amourspirit/python-types-unopy>`_ that gives
full typing support for `LibreOffice API <https://api.libreoffice.org/>`_.
This allows full type support for `ScriptForge <https://gitlab.com/LibreOfficiant/scriptforge>`_
and `LibreOffice API <https://api.libreoffice.org/>`_.
These Typings are created for LibreOffice ``7.6``.
Installation
============
PIP
---
**types-scriptforge** `PyPI <https://pypi.org/project/types-scriptforge/>`_
.. code-block:: bash
$ pip install types-scriptforge
`ScriptForge Docs <https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/lib_ScriptForge.html>`__ on LibreOffice Help.
Older versions
--------------
While this version will also work with previous version of ScriptForge, not all methods/functions are available in previous versions
that are part of this typing library.
To install for version ``7.5``.
.. code-block:: bash
$ pip install "types-scriptforge>=2.0,<3.0"
To install for version ``7.4``.
.. code-block:: bash
$ pip install "types-scriptforge>=1.1,<2.0"
To install for version ``7.3``.
.. code-block:: bash
$ pip install "types-scriptforge<1.1"
Other
=====
**Figure 1:** ScriptForge typings example
.. figure:: https://user-images.githubusercontent.com/4193389/163497042-a572dff9-0278-4d42-be22-dea4555545ff.gif
:alt: types-scriptforge example gif.
After of version ``3.0`` of ``types-scriptforge`` a new version scheme is used that now matches the version release of LibreOffice and ScriptForge.
So ``types-scriptforge`` version ``7.6`` is for LibreOffice version ``7.6``, ``types-scriptforge`` version ``7.7`` is for LibreOffice version ``7.7``
and so on.
Raw data
{
"_id": null,
"home_page": "https://github.com/Amourspirit/python-types-scriptforge",
"name": "types-scriptforge",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "libreoffice,openoffice,scriptforge,typings,uno,ooouno,pyuno",
"author": ":Barry-Thomas-Paul: Moss",
"author_email": "bigbytetech@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a1/35/be8e08427f2537183f0a933d3e3f686b122d2eae062e4cb6e8bb43c737cd/types_scriptforge-7.6.0.1.tar.gz",
"platform": null,
"description": "===================\nScriptForge Typings\n===================\n\nThis project is Type Support (typings) for LibreOffice `ScriptForge <https://gitlab.com/LibreOfficiant/scriptforge>`_\n\nAt the time of this writing there is no other PyPi package for ScriptForge.\nIt is not necessary to have a ScriptForge package to take advantage of\nScriptForge Typings.\n\nScriptForge lives inside of LibreOffice. Using these typings in a modern development IDE\nwill give type Support for the ScriptForge library.\n\nThis project leverages `types-unopy <https://github.com/Amourspirit/python-types-unopy>`_ that gives\nfull typing support for `LibreOffice API <https://api.libreoffice.org/>`_.\nThis allows full type support for `ScriptForge <https://gitlab.com/LibreOfficiant/scriptforge>`_\nand `LibreOffice API <https://api.libreoffice.org/>`_.\n\nThese Typings are created for LibreOffice ``7.6``.\n\nInstallation\n============\n\nPIP\n---\n\n**types-scriptforge** `PyPI <https://pypi.org/project/types-scriptforge/>`_\n\n.. code-block:: bash\n\n $ pip install types-scriptforge\n\n`ScriptForge Docs <https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/lib_ScriptForge.html>`__ on LibreOffice Help.\n\nOlder versions\n--------------\n\nWhile this version will also work with previous version of ScriptForge, not all methods/functions are available in previous versions\nthat are part of this typing library.\n\nTo install for version ``7.5``.\n\n.. code-block:: bash\n\n $ pip install \"types-scriptforge>=2.0,<3.0\"\n\nTo install for version ``7.4``.\n\n.. code-block:: bash\n\n $ pip install \"types-scriptforge>=1.1,<2.0\"\n\nTo install for version ``7.3``.\n\n.. code-block:: bash\n\n $ pip install \"types-scriptforge<1.1\"\n\nOther\n=====\n\n**Figure 1:** ScriptForge typings example\n\n.. figure:: https://user-images.githubusercontent.com/4193389/163497042-a572dff9-0278-4d42-be22-dea4555545ff.gif\n :alt: types-scriptforge example gif.\n\nAfter of version ``3.0`` of ``types-scriptforge`` a new version scheme is used that now matches the version release of LibreOffice and ScriptForge.\nSo ``types-scriptforge`` version ``7.6`` is for LibreOffice version ``7.6``, ``types-scriptforge`` version ``7.7`` is for LibreOffice version ``7.7``\nand so on.",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Type annotations for LibreOffice API",
"version": "7.6.0.1",
"project_urls": {
"Homepage": "https://github.com/Amourspirit/python-types-scriptforge",
"Repository": "https://github.com/Amourspirit/python-types-scriptforge"
},
"split_keywords": [
"libreoffice",
"openoffice",
"scriptforge",
"typings",
"uno",
"ooouno",
"pyuno"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39ec17aeb4d1d10a6189c9232e24f87a2e33c158999848457fbe845b18b0f155",
"md5": "582908770ce148c316078db5c2cd621f",
"sha256": "81f7d4a017714f2472096fff65f1749efc5fa85901bc841bdccfa773a6fa8509"
},
"downloads": -1,
"filename": "types_scriptforge-7.6.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "582908770ce148c316078db5c2cd621f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 73074,
"upload_time": "2023-12-22T02:30:29",
"upload_time_iso_8601": "2023-12-22T02:30:29.403118Z",
"url": "https://files.pythonhosted.org/packages/39/ec/17aeb4d1d10a6189c9232e24f87a2e33c158999848457fbe845b18b0f155/types_scriptforge-7.6.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a135be8e08427f2537183f0a933d3e3f686b122d2eae062e4cb6e8bb43c737cd",
"md5": "ef741ff3f5a771251adaaef92e693945",
"sha256": "36ce0cad23d3cb9e2ddb75420456f52c30ce1ced55472ba3ad0892e6a8e50495"
},
"downloads": -1,
"filename": "types_scriptforge-7.6.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ef741ff3f5a771251adaaef92e693945",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 72996,
"upload_time": "2023-12-22T02:30:31",
"upload_time_iso_8601": "2023-12-22T02:30:31.246180Z",
"url": "https://files.pythonhosted.org/packages/a1/35/be8e08427f2537183f0a933d3e3f686b122d2eae062e4cb6e8bb43c737cd/types_scriptforge-7.6.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-22 02:30:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Amourspirit",
"github_project": "python-types-scriptforge",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "types-scriptforge"
}
JSON
