Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement (Core Feature): Create base GitHub app for Byte #31

Open
JacobCoffee opened this issue Nov 22, 2023 · 0 comments
Open

Enhancement (Core Feature): Create base GitHub app for Byte #31

JacobCoffee opened this issue Nov 22, 2023 · 0 comments
Labels
enhancement ➕ This is a brand new feature or request

Comments

@JacobCoffee
Copy link
Owner

JacobCoffee commented Nov 22, 2023

Summary

For interactions with GitHub (e.g., anything other than reading) I think it would be best to create a GitHub app for API interaction. We can create discussions, reply on issues (#28, etc.), and more.

Looking across the available packages, https://github.com/yanyongyu/githubkit seems like the best fit. It utilizes httpx, has Octokit-like levels of feature set, async support, and is kept up to date.

Basic Example

  • Create GitHub app
  • Process bot requests, interact with library inside of our project, send to GitHub, and vice versa
  • Listen to requests from GitHub through web server API calls/webhooks

https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app

Drawbacks and Impact

No response

Unresolved questions

Project layout could be tricky. Do we have a fourth segment (on top of src/{byte,web,database}) for the GitHub portion, or can we intermingle in the byte "domain"?


Note

We utilize Polar.sh to engage in regular as well as pledge-based > sponsorship.

Check out all issues funded or available for funding on our Polar.sh dashboard

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
  • This, along with engagement in the community, helps us know which features are a priority to our users.
Fund with Polar
@JacobCoffee JacobCoffee added the enhancement ➕ This is a brand new feature or request label Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ➕ This is a brand new feature or request
Projects
None yet
Development

No branches or pull requests

1 participant