Awesome
<!-- *** Thanks for checking out the Best-README-Template. If you have a suggestion *** that would make this better, please fork the repo and create a pull request *** or simply open an issue with the tag "enhancement". *** Thanks again! Now go create something AMAZING! :D --> <!-- PROJECT SHIELDS --> <!-- *** I'm using markdown "reference style" links for readability. *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). *** See the bottom of this document for the declaration of the reference variables *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links --> <!-- PROJECT LOGO --> <br /> <p align="center"> <a href="https://github.com/aaditya2200/IPO-proj"> <img src= https://user-images.githubusercontent.com/22007192/128032739-e939aea3-7c6c-4c76-8691-d86ef3a6f665.png alt="Logo" width="160" height="160"> </a> <h3 align="center">ONE IPO bot</h3> <p align="center"> An awesome README template to jumpstart your projects! <br /> <a href="https://github.com/aaditya2200/IPO-proj.git"><strong>Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/aaditya2200/IPO-proj/issues">Report Bug</a> · <a href="https://github.com/othneildrew/Best-README-Template/issues">Request Feature</a> </p> </p> <!-- TABLE OF CONTENTS --> <details open="open"> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgements">Acknowledgements</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->About The Project
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
- Clone the repo
git clone https://github.com/aaditya2200/IPO-proj.git
- Install pipenv
pip install pipenv
- 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 -->Roadmap
See the open issues for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Contributors
- Aaditya rangarajan
- Amol Derick Soans
License
Distributed under the MIT License. See LICENSE
for more information.