commops/grimoire-perceval-fedmsg-plugin
Archived
16
0
Fork 0
Code Issues 1 Pull requests Activity

Add tasks to README

Browse source 
Signed-off-by: Sachin S. Kamath <sskamath96@gmail.com>
This commit is contained in:
Sachin S Kamath 2018-02-20 22:12:19 +05:30
commit 8d990cd66b
1 changed files with 38 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -1,3 +1,40 @@
# fedmsg-perceval-plugin
A fedmsg plugin for perceval
A fedmsg plugin for perceval
## Welcome GSoC and Outreachy applicants!
This repo is brand new and it's meant to be :)
### Beginner tasks
1. Research about fedmsg and Perceval.
- fedmsg is extensively documented and is used in a lot of Fedora applications. You can read the documentation on [Read the Docs](http://fedmsg.readthedocs.io/) and review applications that are found in the [fedora-infra GitHub repository](https://github.com/fedora-infra).
2. Write a minimal fedmsg app which can trigger an event (can be anything like tweeting, sending an IRC message, or anything crazy {Remember, sky is the limit!}) using fedmsg.
- To get started with this task, please go through Ralph Bean's slides on [How to build your own fedmsg applications](http://threebean.org/presentations/fedmsg-flock14/#/step-1). It is a good starting point if you think fedmsg documentation doesn't answer your questions.
3. Write a basic Perceval plugin which pulls data from any REST API you like (yep, ANY!)
- Perceval has a lot of backends defined already. If you like some real-time examples, head over to the [Perceval backend code](https://github.com/chaoss/grimoirelab-perceval/tree/master/perceval/backends/core) and review all the Python files available there. For instructions on how to use Perceval to gather data, [read the training manual](https://www.gitbook.com/book/grimoirelab/tutorial/details) designed by Grimoirelab developers :)
### Resources & Quick Reference
Fedmsg : http://fedmsg.readthedocs.io/
Perceval : https://github.com/grimoirelab/perceval
Getting started with Grimoire: https://www.gitbook.com/book/grimoirelab/tutorial/details
Writing fedmsg plugins : https://fedmsg.readthedocs.io/en/stable/subscribing/
Existing plugins (code) : https://github.com/chaoss/grimoirelab-perceval/tree/master/perceval/backends/core
If you have any questions about the tasks, please feel free to email skamath [at] fedoraproject [dot] org, or hop on to Freenode IRC and say hello to `skamath` on `#fedora-outreachy` or `#fedora-summer-coding` channel.