Skip to content

Commit

Permalink
Fix bad rebase.
Browse files Browse the repository at this point in the history
  • Loading branch information
tonyandrewmeyer committed Dec 11, 2024
1 parent 79fab7a commit 20786fa
Showing 1 changed file with 0 additions and 26 deletions.
26 changes: 0 additions & 26 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,6 @@ integrations with other services, and making the charm easier to test.

.. _available on PyPI: https://pypi.org/project/ops/

The `ops` library is a Python framework for writing and testing Juju charms.

See more: `Charm SDK documentation <https://juju.is/docs/sdk>`_

The library (`available on PyPI`_) provides:

- :ref:`ops_module`, the API to respond to Juju events and manage the application;
- :ref:`ops_main_entry_point`, used to initialise and run your charm;
- :ref:`ops_pebble_module`, the Pebble client, a low-level API for Kubernetes containers;
- the APIs for unit testing charms in a simulated environment:

- :doc:`State-transition testing </state-transition-testing>`. This is the
recommended approach (it was previously known as 'Scenario').
- :doc:`Harness </harness>`. This is a deprecated framework, and has issues,
particularly with resetting the charm state between Juju events.

You can structure your charm however you like, but with the `ops` library, you
get a framework that promotes consistency and readability by following best
practices. It also helps you organise your code better by separating different
aspects of the charm, such as managing the application's state, handling
integrations with other services, and making the charm easier to test.

.. _available on PyPI: https://pypi.org/project/ops/

.. toctree::
:hidden:
:maxdepth: 2
Expand All @@ -68,8 +44,6 @@ ops

.. _ops_main_entry_point:

.. _ops_main_entry_point:

ops.main entry point
--------------------

Expand Down

0 comments on commit 20786fa

Please sign in to comment.