Metadata-Version: 2.1
Name: odoo-addon-connector_typesense
Version: 18.0.1.0.0.5
Requires-Python: >=3.10
Requires-Dist: odoo-addon-connector_search_engine==18.0.*
Requires-Dist: odoo==18.0.*
Requires-Dist: requests
Requires-Dist: typesense>=1.1.0
Summary: Connector For Typesense Search Engine
Home-page: https://github.com/OCA/search-engine
License: AGPL-3
Author: Derico, Kencove, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

===================
connector_typesense
===================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:0d8f46d9167eae0cccffeb41176ee7c794993bf8fe3988aeeeec1377f9c8cfbf
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsearch--engine-lightgray.png?logo=github
    :target: https://github.com/OCA/search-engine/tree/18.0/connector_typesense
    :alt: OCA/search-engine
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/search-engine-18-0/search-engine-18-0-connector_typesense
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/search-engine&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This addon provides the bases to implement addons to export information
to `Typesense <https://typesense.org>`__ indexes.

**Table of contents**

.. contents::
   :local:

Installation
============

This package requires a typesense search engine running. Please read
this for a [quick docker based
setup](https://typesense.org/docs/guide/install-typesense.html#option-2-local-machine-self-hosting).

Configuration
=============

You have to configure (Host, Port, Protocol, Typesense API Key) in a new
backend form view:

Search Engine > Configuration > Backends

Usage
=====

We recommend to use the typesense-dashboard for managing your typesense
server. I will allow you to configure the mapping of index with a nice
UI. Please take a look here:
https://github.com/bfritscher/typesense-dashboard/releases

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/search-engine/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/search-engine/issues/new?body=module:%20connector_typesense%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Derico
* Kencove

Contributors
------------

- Maik Derstappen <md@derico.de>
- Mohamed Alkobrosli <malkobrosly@kencove.com>
- Sebastien BEAU <sebastien.beau@akretion.com>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/search-engine <https://github.com/OCA/search-engine/tree/18.0/connector_typesense>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
