Skip to content

Commit 84ebdba

Browse files
committed
renaming source-social-network-fetcher into source-twitter-fetcher
Signed-off-by: Alexis Pentori <[email protected]>
1 parent 3859002 commit 84ebdba

File tree

16 files changed

+98
-99
lines changed

16 files changed

+98
-99
lines changed

source-social-network-fetcher/README.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

source-social-network-fetcher/source_social_network_fetcher/__init__.py

Lines changed: 0 additions & 8 deletions
This file was deleted.

source-twitter-fetcher/README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Twitter Fetcher Source
2+
3+
This is the repository for fetching Twitter information, written in Python.
4+
5+
## Todos
6+
7+
* [ ] Implements first version based on original script
8+
* [ ] Fetch the Data users of each count.
9+
* [ ] Fetch Tweets details
10+
* [ ] Improve version:
11+
* limit the data fetching based on input date
12+
13+
14+
## Usage
15+
16+
This connector fetch information from Twitter based on their API: https://developer.twitter.com/en/docs/twitter-api
17+
18+
### Configuration
19+
20+
The connector takes the following input:
21+
22+
```yaml
23+
twitter:
24+
- API-KEY
25+
- Account List
26+
```
27+
28+
### Output
29+
30+
The connector will return the following:
31+
32+
33+
## Local development
34+
35+
### Prerequisites
36+
37+
#### Activate Virtual Environment and install dependencies
38+
From this connector directory, create a virtual environment:
39+
```
40+
python -m venv .venv
41+
```
42+
```
43+
source .venv/bin/activate
44+
pip install -r requirements.txt
45+
```
46+
47+
### Locally running the connector
48+
```
49+
python main.py spec
50+
python main.py check --config sample_files/config-example.json
51+
python main.py discover --config sample_files/config-example.json
52+
python main.py read --config sample_files/config-example.json --catalog sample_files/configured_catalog.json
53+
```
54+
55+
### Locally running the connector docker image
56+
57+
```bash
58+
docker build -t airbyte/twitter-fetcher:dev .
59+
# Running the spec command against your patched connector
60+
docker run airbyte/twitter-fetcher:dev spec
61+
````
62+
63+
#### Run
64+
Then run any of the connector commands as follows:
65+
```
66+
docker run --rm airbyte/twitter-fetcher:dev spec
67+
docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/twitter-fetcher:dev check --config /sample_files/config-example.json
68+
docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/twitter-fetcher:dev discover --config /sample_files/config-example.json
69+
docker run --rm -v $(pwd)/sample_files:/sample_files -v $(pwd)/sample_files:/sample_files airbyte/twitter-fetcher:dev read --config /sample_files/config-example.json --catalog /sample_files/configured_catalog.json
70+
```

source-social-network-fetcher/main.py renamed to source-twitter-fetcher/main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
33
#
44

5-
from source_social_network_fetcher.run import run
5+
from source_twitter_fetcher.run import run
66

77
if __name__ == "__main__":
88
run()

source-social-network-fetcher/metadata.yaml renamed to source-twitter-fetcher/metadata.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ data:
1010
connectorSubtype: api
1111
connectorType: source
1212
definitionId: 1c448bfb-8950-478c-9ae0-f03aaaf4e920
13-
dockerImageTag: '0.0.3'
14-
dockerRepository: status-im/airbyte/social-network-fetcher
15-
githubIssueLabel: source-social-network-fetcher
16-
icon: social-network-fetcher.svg
13+
dockerImageTag: '0.0.1'
14+
dockerRepository: status-im/airbyte/source-twitter-fetcher
15+
githubIssueLabel: source-twitter-fetcher
16+
icon: twitter-fetcher.svg
1717
license: MIT
18-
name: Social Network Fetcher
18+
name: Twitter Fetcher
1919
releaseDate: TODO
2020
supportLevel: community
2121
releaseStage: alpha
22-
documentationUrl: https://docs.airbyte.com/integrations/sources/social-network-fetcher
22+
documentationUrl: https://docs.airbyte.com/integrations/sources/twitter-fetcher
2323
tags:
2424
- language:python
2525
metadataSpecVersion: "1.0"

source-social-network-fetcher/setup.py renamed to source-twitter-fetcher/setup.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
]
1818

1919
setup(
20-
name="source_social_network_fetcher",
21-
description="Source implementation for Social Network Fetcher.",
20+
name="source_twitter_fetcher",
21+
description="Source implementation for Twitter Fetcher.",
2222
author="Status",
2323
author_email="[email protected]",
2424
packages=find_packages(),
@@ -29,7 +29,7 @@
2929
},
3030
entry_points={
3131
"console_scripts": [
32-
"source-social-network-fetcher=source_social_network_fetcher.run:run",
32+
"source-twitter-fetcher=source_twitter_fetcher.run:run",
3333
],
3434
},
3535
)

0 commit comments

Comments
 (0)