index.rst 3.04 KB
Newer Older
AJ Steers's avatar
AJ Steers committed
1
2
3
4
5
6
7
8
.. Meltano SDK documentation master file, created by
   sphinx-quickstart on Thu Jun  3 14:38:15 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Meltano SDK for Taps and Targets
=======================================

9
The Meltano_ SDK for Taps and Targets is the fastest way to build custom 
10
11
data extractors and loaders! Taps and targets built on the SDK are automatically compliant with the 
`Singer Spec`_, the de-facto open source standard for extract and load pipelines.
AJ Steers's avatar
AJ Steers committed
12
13
14
15
16
17
18
19
20

Future-proof extractors and loaders, with less code
---------------------------------------------------

On average, developers tell us that they write about 70% less code by using the SDK, which makes
learning the SDK a great investment. Furthermore, as new features and capabilities are added
to the SDK, your taps and targets can always take advantage of the latest capabilities and
bug fixes, simply by updating your SDK dependency to the latest version.

21
Built by Meltano and the Singer Community
22
23
-----------------------------------------

24
25
26
27
28
The SDK is built with love by the Meltano_ core
team and contributors, with contributions from developers across the Singer_ 
open source community. SDK-based plugins can easily be `integrated with Meltano`_,
but they can also be used in any data pipeline tool that supports the
`Singer Spec`_.
29

30
31
32
33
The SDK project is 100% open source, licensed under the `Apache 2.0`_
permissive license. Please visit our code repo `here in Gitlab`_, where you can
read the `source code`_, `log an issue or feature request`_, and `contribute back`_
to the SDK. We also regularly discuss SDK topics in our `Meltano Slack`_ community,
34
within the `#singer-tap-development`_ and `#singer-target-development`_ Slack channels.
AJ Steers's avatar
AJ Steers committed
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

Developer Resources
-------------------

.. toctree::
   :maxdepth: 2

   dev_guide
   python_tips
   code_samples
   cli_commands

Reference
---------
   
.. toctree::
   :maxdepth: 2

   reference
   

Advanced Topics
---------------

.. toctree::
   :maxdepth: 1

   parent_streams
   partitioning
64
   stream_maps
AJ Steers's avatar
AJ Steers committed
65
66
67
68
69
   porting
   CONTRIBUTING
   implementation/README

.. _Singer: https://singer.io
70
.. _Singer Spec: https://hub.meltano.com/singer/spec
AJ Steers's avatar
AJ Steers committed
71
.. _Meltano: https://www.meltano.com
72
73
74
75
76
77
78
.. _integrated with Meltano: https://meltano.com/tutorials/create-a-custom-extractor.html#add-the-plugin-to-your-meltano-project
.. _contribute back: https://gitlab.com/meltano/sdk/-/issues?scope=all&state=opened&label_name[]=Accepting%20Merge%20Requests
.. _source code: https://gitlab.com/meltano/sdk
.. _log an issue or feature request: https://gitlab.com/meltano/sdk/-/issues
.. _Apache 2.0: https://en.wikipedia.org/wiki/Apache_License
.. _here in Gitlab: https://gitlab.com/meltano/sdk
.. _Meltano Slack: https://join.slack.com/t/meltano/shared_invite/zt-obgpdeba-7yrqKhwyMBfdHDXsZY8G7Q
79
80
.. _#singer-tap-development: https://meltano.slack.com/archives/C01PKLU5D1R
.. _#singer-target-development: https://meltano.slack.com/archives/C01RKUVUG4S
AJ Steers's avatar
AJ Steers committed
81
82
83
84
85
86

Index and Search
----------------

* :ref:`genindex`
* :ref:`search`