Skip to content

Commit 7dcf629

Browse files
authored
bump version to 0.14.1-beta1 (#18)
* bump version to 0.14.1-beta1 # Conflicts: # poetry.lock * poetry lock
1 parent 81b330d commit 7dcf629

File tree

4 files changed

+65
-49
lines changed

4 files changed

+65
-49
lines changed

.github/CODEOWNERS

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
# the repo. Unless a later match takes precedence,
88
# @global-owner1 and @global-owner2 will be requested for
99
# review when someone opens a pull request.
10-
* @jbristow @zprobst @ccloes @angelosantos4
10+
* @jbristow @zprobst @ccloes @angelosantos4 @rreddy15

README.md

+37-24
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,32 @@
11
# nodestream-plugin-github
22

33
# Overview
4-
This plugin provides a way to scrape github data from the REST api and ingest
5-
them as extractors in nodestream pipelines.
64

5+
This plugin provides a way to scrape GitHub data from the REST api and ingest
6+
them as extractors in nodestream pipelines.
77

88
# Setup Neo4j
9+
910
1. Download and install Neo4j: https://neo4j.com/docs/desktop-manual/current/installation/download-installation/
10-
1. Create and start database (version 5.7.0: https://neo4j.com/docs/desktop-manual/current/operations/create-dbms/
11-
1. Install APOC: https://neo4j.com/docs/apoc/5/installation/
11+
2. Create and start database (version 5.7.0: https://neo4j.com/docs/desktop-manual/current/operations/create-dbms/
12+
3. Install APOC: https://neo4j.com/docs/apoc/5/installation/
1213

13-
# Create github credentials
14-
1. Create and github access codes: https://docs.github.com/en/[email protected]/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app
15-
NOTE: These values will be used in your `.env`
14+
# Create GitHub credentials
15+
16+
1. Create and GitHub access
17+
codes: https://docs.github.com/en/[email protected]/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app
18+
NOTE: These values will be used in your `.env`
1619

1720
# Install and run the app
18-
1. Install python3: https://www.python.org/downloads/
19-
1. Install poetry: https://python-poetry.org/docs/#installation
20-
1. Install nodestream: https://nodestream-proj.github.io/nodestream/0.5/docs/tutorial/
21-
1. Generate a new nodestream project
22-
1. Add `nodestream-github` to your project dependencies in your nodestream projects pyproject.toml file.
23-
1. Install necessary dependencies: `poetry install`
24-
1. In `nodestream.yaml` add the following:
21+
22+
1. Install python3: https://www.python.org/downloads/
23+
2. Install poetry: https://python-poetry.org/docs/#installation
24+
3. Install nodestream: https://nodestream-proj.github.io/nodestream/0.5/docs/tutorial/
25+
4. Generate a new nodestream project
26+
5. Add `nodestream-github` to your project dependencies in your nodestream projects pyproject.toml file.
27+
6. Install necessary dependencies: `poetry install`
28+
7. In `nodestream.yaml` add the following:
29+
2530
```yaml
2631
plugins:
2732
- name: github
@@ -34,25 +39,33 @@ plugins:
3439
all_public: True
3540
rate_limit_per_minute: 225
3641
targets:
37-
- my-db:
42+
- my-db:
3843
pipelines:
39-
- name: github_repos
40-
- name: github_teams
44+
- name: github_repos
45+
- name: github_teams
4146
targets:
42-
database: neo4j
43-
uri: bolt://localhost:7687
44-
username: neo4j
45-
password: neo4j123
47+
database: neo4j
48+
uri: bolt://localhost:7687
49+
username: neo4j
50+
password: neo4j123
4651
```
52+
4753
1. Set environment variables in your terminal session for: `GITHUB_ACCESS_TOKEN`.
48-
1. Verify nodestream has loaded the pipelines: `poetry run nodestream show`
49-
1. Use nodestream to run the pipelines: `poetry run nodestream run <pipeline-name> --target my-db`
54+
2. Verify nodestream has loaded the pipelines: `poetry run nodestream show`
55+
3. Use nodestream to run the pipelines: `poetry run nodestream run <pipeline-name> --target my-db`
5056

5157
# Using make
58+
5259
1. Install make (ie. `brew install make`)
53-
1. Run `make run`
60+
2. Run `make run`
5461

62+
# Contributing
63+
64+
When contributing, make sure to sign your commits. To find out more about how to do this, refer to
65+
this [GitHub documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
5566

5667
# Authors
68+
5769
* Jon Bristow
5870
* Zach Probst
71+
* Rohith Reddy

poetry.lock

+20-20
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
[tool.poetry]
22
name = "nodestream-plugin-github"
3-
version = "0.14.0-beta.1"
3+
version = "0.14.1-beta.1"
44
description = ""
5-
authors = ["Jon Bristow <[email protected]>"]
5+
authors = [
6+
"Jon Bristow <[email protected]>",
7+
"Rohith Reddy <[email protected]>"
8+
]
69
packages = [
710
{ include = "nodestream_github" }
811
]
@@ -16,8 +19,8 @@ tenacity = "^9.0.0"
1619
httpx = ">=0.27,<0.28"
1720

1821
[tool.poetry.group.dev.dependencies]
19-
ruff = "^0.9"
20-
black = "^25.1"
22+
ruff = "^0.11.0"
23+
black = "^25.1.0"
2124
isort = "^6.0.0"
2225
pytest = "^8.3.4"
2326
pytest-asyncio = "^0.25.3"

0 commit comments

Comments
 (0)