tap-forem
Singer tap for the Forem API.
Built with the Meltano SDK for Singer Taps and Targets.
Capabilities
catalogdiscoveraboutstream-maps
TODO
state
Settings
| Setting | Required | Default | Description |
|---|---|---|---|
| api_key | True | None | The Forem API key. |
| tag | True | None | Tag for filter articles by. |
| api_url | False | https://dev.to/api/ | The url for the API service. |
A full list of supported settings and capabilities is available by running: tap-forem --about
Source Authentication and Authorization
Follow the official docs in https://developers.forem.com/api#section/Authentication.
Usage
You can easily run tap-forem by itself or in a pipeline using Meltano.
Executing the Tap Directly
tap-forem --version
tap-forem --help
tap-forem --config CONFIG --discover > ./catalog.json
Developer Resources
Initialize your Development Environment
First, install uv.
Then, install the project dependencies:
uv sync
Create and Run Tests
Create tests within the tests folder and
then run:
uv run pytest
You can also test the tap-forem CLI interface directly using uv run:
uv run tap-forem --help
Testing with Meltano
Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.
Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
# Install meltano
uv tool install meltano
# Initialize meltano within this directory
cd tap-forem
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-forem --version
# Or run a pipeline:
meltano run tap-forem target-jsonl
SDK Dev Guide
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.
Metadata
Release files for tap-forem 0.5.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tap_forem-0.5.4.tar.gz | 76.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tap_forem-0.5.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 89.9 kB
Release files / tap_forem-0.5.4.tar.gz
| Download URL | tap_forem-0.5.4.tar.gz |
|---|---|
| Size | 76.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
22c27a40e16f58b21990162badfb62eb371a3c404ef878468212bbe09146d3c1
|
|
BLAKE2b-256 checksum How to use checksums |
dacaf5200d7828ed170183ca3c97ecdd9dc9aa4776166f46fa4a021d087f6240
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 25, 2025.
Transparency logRelease files / tap_forem-0.5.4-py3-none-any.whl
| Download URL | tap_forem-0.5.4-py3-none-any.whl |
|---|---|
| Size | 13.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b0e6eee4a45eb825e31c1dee0914760440fba863ad49131d5e409d9d8cc2d7e
|
|
BLAKE2b-256 checksum How to use checksums |
ea1575dd437c5c110f98d74ecc91f1e0d1f77de4edeafe528e93f918abbe8822
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 25, 2025.
Transparency log
