LatvianPython/pyoracle_forms

##################################################################
pyoracle_forms
##################################################################

.. image:: https://raw.githubusercontent.com/LatvianPython/pyoracle_forms/master/media/coverage.svg?sanitize=true
    :target: https://github.com/LatvianPython/pyoracle_forms
    :alt: Coverage

.. image:: https://img.shields.io/pypi/pyversions/pyoracle_forms
    :target: https://www.python.org/downloads/
    :alt: Python

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Black

.. image:: https://img.shields.io/pypi/v/pyoracle_forms
    :target: https://pypi.org/project/pyoracle-forms/
    :alt: PyPI

.. image:: https://readthedocs.org/projects/pyoracle-forms/badge/?version=latest
    :target: https://pyoracle-forms.readthedocs.io/en/latest/?badge=latest
    :alt: Read the Docs

.. image:: https://img.shields.io/codeclimate/maintainability/LatvianPython/pyoracle_forms
    :target: https://codeclimate.com/github/LatvianPython/pyoracle_forms
    :alt: Code Climate maintainability

.. image:: http://www.mypy-lang.org/static/mypy_badge.svg
    :target: http://mypy-lang.org/
    :alt: Checked with mypy


Wraps the Oracle Forms API under Python, so that you can write scripts to
make programmatic changes to Oracle Forms .fmb files with ease.

##################################################################
Installation and usage
##################################################################

******************************************************************
Installation
******************************************************************
The package can be installed from PyPI with ``pip install pyoracle-forms``

******************************************************************
Usage
******************************************************************
.. code-block:: python

    from pyoracle_forms import Module, initialize_context
    initialize_context(version="12c", encoding="utf-8")

    with Module.load("./your_form.fmb") as module:
        for data_block in module.data_blocks:
            for item in data_block.items:
                item.font_name = "Comic Sans MS"

        module.save()

Best used with an interactive environment, such as Jupyter Notebook, as you get better autocomplete
there due to attributes getting determined dynamically.

You also need access to successfully installed version of Oracle Forms, otherwise the scripts won't work,
as this solution depends on the Oracle Forms API.


******************************************************************
Documentation
******************************************************************

More detailed documentation is available on `Read the Docs <https://pyoracle-forms.readthedocs.io/en/latest/>`_