README.md

ONE IPO bot

An awesome README template to jumpstart your projects!
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

https://user-images.githubusercontent.com/22007192/128032228-08115b98-6a05-4008-8103-be932cf290d5.mov

Telegram Bot that is all about :chart_with_upwards_trend: IPOs (Initial Public Offerings In India). Built in python

Features:

:white_check_mark: List Current and upcoming IPOs
:white_check_mark: Subscribe to an IPO to get updates only about it
:white_check_mark: Access Various metrics and documents like RHP from telegram

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• [Python]
• [Redis]
• [PyTelegramAPIBot]
• [BeautifulSoup]

Getting Started

Using Pipenv I recommend using Pycharm for this, even though I am on vscode for now. Several reasons, but mostly to do with how the backend works We run each task through the command line. For example, python main.py <<task_name>> For the above command to run, we need to edit the debug configurations by adding parameters, I do not know how to do that in vscode, hence I recommend going to PyCharm. also download redis, installation is pretty simple

needs work

Prerequisites

needs work

• pip

  pip install PyTelgramAPIBot
  

Installation

1. Clone the repo

   git clone https://github.com/aaditya2200/IPO-proj.git
   

2. Install pipenv

   pip install pipenv
   

3. Enter into pipshell

   pipenv shell
   

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contributors

• Aaditya rangarajan
• Amol Derick Soans

License

Distributed under the MIT License. See LICENSE for more information.