Commit 9d7c764b authored by AJ Steers's avatar AJ Steers
Browse files

update SDK refs in docs and cookiecutter

parent a49e2af6
......@@ -12,7 +12,7 @@
2. [ ] Create a corresponding MR on a branch named `<issue>-release-vX-Y-Z` (the default name if your issue is titled correctly)
3. [ ] The `release-vX.Y.Z` MR is ready when:
1. [ ] Changelog includes all meaningful user-facing updates since the last release
- [ ] Compare against `main` branch [commit history](https://gitlab.com/meltano/singer-sdk/-/commits/main)
- [ ] Compare against `main` branch [commit history](https://gitlab.com/meltano/sdk/-/commits/main)
2. [ ] Version is bumped:
- [ ] `pyproject.toml`
- [ ] `docs/conf.py`
......@@ -26,12 +26,12 @@
5. [ ] Merge to `main` with the merge commit message `Release vX.Y.Z`
2. [ ] Release steps:
1. [ ] Manual:
1. [ ] [Cut a tag](https://gitlab.com/meltano/singer-sdk/-/tags/new) from `main` named `vX.Y.Z` with Message=`Release vX.Y.Z`
1. [ ] [Cut a tag](https://gitlab.com/meltano/sdk/-/tags/new) from `main` named `vX.Y.Z` with Message=`Release vX.Y.Z`
- _Note: tag name must exactly match poetry version text_
2. [ ] Automated [CD pipeline](https://gitlab.com/meltano/singer-sdk/-/pipelines?scope=tags):
2. [ ] Automated [CD pipeline](https://gitlab.com/meltano/sdk/-/pipelines?scope=tags):
- In response to new tag creation, these steps are performed automatically in Gitlab pipelines:
- Abort if tag `vX.Y.Z` does not match output from `poetry version --short`
- Publish to [PyPi](https://pypi.org/project/singer-sdk/#history)
- Publish to [PyPi](https://pypi.org/project/sdk/#history)
- [ ] Check this box when confirmed
- Create a Gitlab 'Release' from the specified tag
......
......@@ -12,13 +12,13 @@ pipx install cookiecutter
Initialize Cookiecutter template directly from Git:
```bash
cookiecutter https://gitlab.com/meltano/singer-sdk --directory="cookiecutter/tap-template"
cookiecutter https://gitlab.com/meltano/sdk --directory="cookiecutter/tap-template"
```
Or locally from an already-cloned `singer-sdk` repo:
Or locally from an already-cloned `sdk` repo:
```bash
cookiecutter ./singer-sdk/cookiecutter/tap-template
cookiecutter ./sdk/cookiecutter/tap-template
```
See the [dev guide](https://gitlab.com/meltano/singer-sdk/-/blob/main/docs/dev_guide.md).
See the [dev guide](https://gitlab.com/meltano/sdk/-/blob/main/docs/dev_guide.md).
......@@ -2,7 +2,7 @@
`{{ cookiecutter.tap_id }}` is a Singer tap for {{ cookiecutter.source_name }}.
Built with the Meltano [SDK](https://gitlab.com/meltano/singer-sdk) for Singer Taps.
Built with the Meltano [SDK](https://gitlab.com/meltano/sdk) for Singer Taps.
## Installation
......@@ -96,5 +96,5 @@ meltano elt {{ cookiecutter.tap_id }} target-jsonl
### SDK Dev Guide
See the [dev guide](https://gitlab.com/meltano/singer-sdk/-/blob/main/docs/dev_guide.md) for more instructions on how to use the SDK to
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.
# Singer SDK Target Template
# SDK Target Template
To use this cookie cutter template:
......@@ -12,13 +12,13 @@ pipx install cookiecutter
Initialize Cookiecutter template directly from Git:
```bash
cookiecutter https://gitlab.com/meltano/singer-sdk --directory="cookiecutter/target-template"
cookiecutter https://gitlab.com/meltano/sdk --directory="cookiecutter/target-template"
```
Or locally from an already-cloned `singer-sdk` repo:
Or locally from an already-cloned `sdk` repo:
```bash
cookiecutter ./singer-sdk/cookiecutter/target-template
cookiecutter ./sdk/cookiecutter/target-template
```
See the [dev guide](../../docs/dev_guide.md).
......@@ -95,7 +95,7 @@ meltano invoke {{ cookiecutter.target_id }} --version
meltano elt tap-carbon-intensity {{ cookiecutter.target_id }}
```
### Singer SDK Dev Guide
### SDK Dev Guide
See the [dev guide](../../docs/dev_guide.md) for more instructions on how to use the Singer SDK to
develop your own taps and targets.
See the [dev guide](../../docs/dev_guide.md) for more instructions on how to use the Meltano SDK to
develop your own Singer taps and targets.
......@@ -15,7 +15,7 @@ pipx install poetry
Now you can use Poetry to install package dependencies:
```bash
cd singer-sdk
cd sdk
```
```bash
......@@ -38,7 +38,7 @@ First clone, then...
- We use `coverage` for code coverage metrics.
- The project-wide max line length is `89`.
- In the future we will add support for linting
[pre-commit hooks](https://gitlab.com/meltano/singer-sdk/-/issues/12) as well.
[pre-commit hooks](https://gitlab.com/meltano/sdk/-/issues/12) as well.
4. Set interpreter to match poetry's virtualenv:
- In VS Code, run `Python: Select interpreter` and select the poetry interpreter.
......
......@@ -15,7 +15,7 @@ import sys
sys.path.insert(0, os.path.abspath(".."))
# sys.path.insert(0, os.path.abspath("../singer_sdk"))
# sys.path.insert(0, os.path.abspath("/Users/ajsteers/Source/singer-sdk"))
# sys.path.insert(0, os.path.abspath("/Users/ajsteers/Source/sdk"))
# -- Project information -----------------------------------------------------
......
......@@ -2,7 +2,7 @@
## Tap Development Overview
Create taps with `singer-sdk` requires overriding just two or three classes:
Create taps with the SDK requires overriding just two or three classes:
1. The `Tap` class. This class governs configuration, validation,
and stream discovery.
......@@ -21,7 +21,7 @@ Create taps with `singer-sdk` requires overriding just two or three classes:
## Target Development Overview
Create targets with `singer-sdk` requires overriding just two classes:
Create targets with the SDK requires overriding just two classes:
1. The `Target` class. This class governs configuration, validation,
and stream discovery.
......@@ -53,13 +53,13 @@ pipx install cookiecutter
Now you can initialize your new project with the Cookiecutter template for taps:
```bash
cookiecutter https://gitlab.com/meltano/singer-sdk --directory="cookiecutter/tap-template"
cookiecutter https://gitlab.com/meltano/sdk --directory="cookiecutter/tap-template"
```
...or for targets:
```bash
cookiecutter https://gitlab.com/meltano/singer-sdk --directory="cookiecutter/target-template"
cookiecutter https://gitlab.com/meltano/sdk --directory="cookiecutter/target-template"
```
Once you've answered the cookiecutter prompts, follow the instructions in the
......
# [SDK Implementation Details](./README.md) - Catalog Metadata
_**Note:**: The SDK does not yet generate metadata as a part of catalog discovery output.
This work is [tracked here](https://gitlab.com/meltano/singer-sdk/-/issues/91) for future
This work is [tracked here](https://gitlab.com/meltano/sdk/-/issues/91) for future
development._
## See Also
......
......@@ -31,7 +31,7 @@ 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,
within the dedicated `#singer-sdk`_ Slack channel.
within the `#singer-tap-development`_ and `#singer-target-development`_ Slack channels.
Developer Resources
-------------------
......@@ -76,7 +76,8 @@ Advanced Topics
.. _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
.. _#singer-sdk: https://meltano.slack.com/archives/C01PKLU5D1R
.. _#singer-tap-development: https://meltano.slack.com/archives/C01PKLU5D1R
.. _#singer-target-development: https://meltano.slack.com/archives/C01RKUVUG4S
Index and Search
----------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment