Skip to content

Commit

Permalink
Update docs around import/export
Browse files Browse the repository at this point in the history
  • Loading branch information
atodorov committed Jul 9, 2020
1 parent c1d1af4 commit eaf1ad5
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/source/import-export/index.rst
Expand Up @@ -24,24 +24,29 @@ XML, CSV, JSON are machine redable file formats which are not designed for
human consumption so this is not a compelling reason to add support
for them!

Kiwi TCMS however exports a very powerful API. The same API is used by
Kiwi TCMS however provides a very powerful API. The same API is used by
our front-end interface via JavaScript! Using this API you can create
a script which will parse your input files, possibly reorganize them
and send the information to Kiwi TCMS. This gives you the ultimate control
over how to import and export data to/from Kiwi TCMS!

Example(s) how to use this API can be found
`here <https://github.com/kiwitcms/api-scripts>`_.

Further information can be found at :ref:`api` and
https://tcms-api.readthedocs.io/en/latest/modules/tcms_api.plugin_helpers.html.

Kiwi TCMS API is exported over both XML-RPC and JSON-RPC protocols which
are industry standards and available for any programming language because
they build on top of HTTP. If you are not able to find appropriate examples
in your own programming language please ask our community for help.

.. important::

Please be a good open source citizen and share your import/export scripts
with the rest of the Kiwi TCMS community. You are welcome to do so by
opening a pull request at https://github.com/kiwitcms/api-scripts.

.. important::

Alternatively you can develop your customized import/export as a web
application and distribute it to your users as a Kiwi TCMS plugin.
If your team doesn't have expertise working with Python and you'd rather
have something done quickly Kiwi TCMS is able to assist you with
additional engineering services. Please see
https://kiwitcms.org/#subscriptions for more information!

0 comments on commit eaf1ad5

Please sign in to comment.