search

musically-ut / first-timers-only-bot

① First timers only issue tweeting bot.
https://twitter.com/first_tmrs_only
BSD 3-Clause "New" or "Revised" License
52 stars 23 forks source link

creds.json db.json structure #10

Closed arshadkazmi42 closed 5 years ago

arshadkazmi42 commented 5 years ago

Can someone give details about the creds.json and db.json structure. And how to run this application.

musically-ut commented 5 years ago

The creds.json should have the following structure (sensitive values removed):

(ssh session)$ cat credentials.json
{
    "Consumer Key": "...",
    "Consumer Secret": "...",
    "Access Token": "...",
    "Access Token Secret": "...",
    "Owner": "twitter_account_name",
    "Owner ID": twitter_account_id
}

the db.json file can be created by running the run.py with the --only-save argument:

python first_timers/run.py --creds-path credentials.json --db-path data/db.json --only-save

Running the script without --only-save will find the issues which have been created, but are not part of the DB and will post tweets about it.

I run it once every 5 minutes to look for such issues on a server.

Hope that helps!

What do you want to use it for?

arshadkazmi42 commented 5 years ago

@musically-ut Thanks alot for the these details. I think you should add these in the README too.

What do you want to use it for?

The tweet bot you have created is really great. I was interested in exploring it. Also was thinking, how about creating similar bot for good first issue

musically-ut commented 5 years ago

That shouldn't be too tricky to do; go for it!

This bot too posted about such issues, but the support for them was removed after a discussion here: https://github.com/musically-ut/first-timers-only-bot/pull/3

However, it was agreed (see the last comment) that having such a bot would also be a good idea.

arshadkazmi42 commented 5 years ago

Well I agree with the discussion there. It's correct merging alot of labels in single bot is not a good idea. But having separate bots would be fine I guess. As, when I started with opensource, I used first-timers-only bot but after I was done with it, I needed a good-first-issue bot too. I think any other label bot doesn't makes much sense, but having first-timers and good-first-issue bot is not a bad idea. What do you think? Any thoughts? I am planning on forking this repo and create a good-first-issue bot.

musically-ut commented 5 years ago

Yup, you have a green light from me!

arshadkazmi42 commented 5 years ago

Cool. Just wanted to know, where do you host your bot? Any suggestions for that?

musically-ut commented 5 years ago

I host it on a personal Vultur server. I can host your bot too if in a pinch. :)

arshadkazmi42 commented 5 years ago

I host it on a personal Vultur server. I can host your bot too if in a pinch. :)

@musically-ut I got my bot setup. I am low on funds to buy my own server to run the bot. Can I host my bot on your servers. I am trying to get some donators/backers for server costs.

musically-ut commented 5 years ago

Great!

Sure, I'll just need the creds.json (over e-mail), and I'll be happy to keep the bot running!

Have you tested out your bot on a local machine by creating an account on Twitter and creating the necessary access/Oauth tokens?

If so, just drop me an e-mail and we'll continue the conversation there.

arshadkazmi42 commented 5 years ago

Thanks. I tested the bot locally. I will draft an email and send it to you. Can you share your email id?

musically-ut commented 5 years ago

I'm @musically_ut on Twitter, DM me there and I'll share my e-mail.

arshadkazmi42 commented 5 years ago

@musically-ut I know this is really old issue. I was thinking we can add a how-to-use doc in the repository and close the bug. I have created a how to use doc for first issues which I forked from this. https://github.com/arshadkazmi42/first-issues/blob/master/HOW_TO_USE.md

I can send a PR with this doc. Any thoughts?

musically-ut commented 5 years ago

Yes, the HOW_TO looks good, please do create a PR with it.

Also, include a link to first-issue (GitHub repository as well as the Twitter bot) in the README while you are at it. :)

Thanks!