Skip to content

Commit

Permalink
docs: omit outdated info
Browse files Browse the repository at this point in the history
  • Loading branch information
mtth committed Dec 1, 2024
1 parent 39753d9 commit 9f5995a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 18 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@

## Licensing

The SDK is licensed under Apache 2.0. The Opvious platform is available both as a managed cloud service (free on small datasets) and self-hosted (free for non-commercial projects). See our [plans page](https://www.opvious.io/plans) for more information.
The SDK is licensed under Apache 2.0. The Opvious platform is available as a self-hosted service, free for small projects. See our [plans page](https://www.opvious.io/plans) for more information.
6 changes: 0 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,6 @@ First install the SDK, for example using `pip`:
be omitted for compatibility with `Pyodide`_ environments, for example in
`JupyterLite`_ kernels.

We recommend you generate an `API access token`_ and set it as `OPVIOUS_TOKEN`
environment variable. This optional step allows you to optimize larger datasets
and increases rate limits.

You are now ready to hop on over to the :ref:`Overview` section!


Expand All @@ -57,7 +53,6 @@ External resources
------------------

+ `Examples repository`_
+ `Platform documentation`_
+ `GitHub repository`_
+ `PyPI entry`_

Expand All @@ -70,4 +65,3 @@ External resources
.. _PyPI entry: https://pypi.python.org/pypi/opvious/
.. _GitHub repository: https://github.com/opvious/sdk.py
.. _Examples repository: https://github.com/opvious/examples
.. _Platform documentation: https://docs.opvious.io
14 changes: 4 additions & 10 deletions docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ done, the recommended way to create clients is via :meth:`.Client.default`.

.. code-block:: python
client = opvious.Client.default("http://localhost:8080") # Local API server
client = opvious.Client.default(opvious.DEMO_ENDPOINT) # Demo cloud endpoint
client = opvious.Client.default("http://localhost:8080") # Local API server
The first argument, `endpoint`, determines the client's underlying API. For
example the address of a self-hosted `API server
<https://hub.docker.com/r/opvious/api-server>`_. As a convenience, we also
provide :meth:`.Client.from_environment` which creates a client from the
`OPVIOUS_ENDPOINT` and `OPVIOUS_TOKEN` environment variables:
<https://hub.docker.com/r/opvious/api-server>`_. The SDK also provides
:meth:`.Client.from_environment` to create clients from the `OPVIOUS_ENDPOINT`
and `OPVIOUS_TOKEN` environment variables:

.. code-block:: python
Expand Down Expand Up @@ -111,12 +111,6 @@ and highlight any errors:
Specifications
--------------

.. note::
Refer to the `platform documentation <https://docs.opvious.io>`_ for
information on how to write a specification directly. You can also find
various sample sources in our `example repository
<https://github.com/opvious/examples/tree/main/sources>`_.

This SDK provides utilities for loading specifications from various locations,
listed below.

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = 'poetry.core.masonry.api'

[tool.poetry]
name = 'opvious'
version = '0.22.0rc1'
version = '0.22.1rc1'
description = 'Opvious Python SDK'
authors = ['Opvious Engineering <oss@opvious.io>']
readme = 'README.md'
Expand Down

0 comments on commit 9f5995a

Please sign in to comment.