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

[Documentation] Code Review & Documentation Improvements #1

Open
sidharthshah opened this issue Jan 15, 2018 · 3 comments
Open

[Documentation] Code Review & Documentation Improvements #1

sidharthshah opened this issue Jan 15, 2018 · 3 comments

Comments

@sidharthshah
Copy link
Collaborator

Review current documentation and comment on how the code can be improved

@sidharthshah
Copy link
Collaborator Author

sidharthshah commented Jan 15, 2018

Some comments on doing code review:

  1. We need to encapsulate all functions related to bot {all functions with send_} int to Bot class
  2. What all methods do I need to write should I want to implement my custom bot? {Think about interfaces}
  3. Create a utils.py have all decorators in there?
  4. We should also create few test, I suggest we use pytest, I have compiled few example on how to use pytest here

Another good tutorial for pytest

Let me know what you think?

@sidharthshah sidharthshah changed the title Code Review & Documentation Improvements [Documentation] Code Review & Documentation Improvements Jan 15, 2018
@sidharthshah
Copy link
Collaborator Author

Few more resources that are relevant include:

  1. ChatOps from StackStorm
  2. Telethon - this is the library that we've used
  3. Telegram's Official Blog Post
  4. Bot Code Examples

@sidharthshah
Copy link
Collaborator Author

Some notes from our review meeting yesterday:

High level structure of Documentation

  1. Telegram Concepts
  2. Dependencies
  3. Bootstrapping and Installation Steps

High Level Steps for Installation:

  1. Register a Bot
  2. Create Telegram Application
  3. Edit settings {Telegram Token, App ID, App Hash, Phone Number, Session}
  4. Edit settings
  5. Install MongoDB {This is used for User and Group Management}
  6. Bootstrap Script
  7. Start API
  8. Hit API

@yspanchal I've added some notes on this comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant