sodafoundation / delfin

delfin is the SODA Infrastructure Manager project which provides unified, intelligent and scalable resource management, alert and performance monitoring
https://sodafoundation.io/
Apache License 2.0
202 stars 355 forks source link

Add documentation about pycharm ide for dev purpose #835

Open sushanthakumar opened 2 years ago

sushanthakumar commented 2 years ago

Issue/Feature Description: pycharm ide has rich set of features for python development. Adding documentation can help for effective contribution

Why this issue to fixed / feature is needed(give scenarios or use cases):

How to reproduce, in case of a bug:

Other Notes / Environment Information: (Please give the env information, log link or any useful information for this issue)

SODACODE2022

skdwriting commented 2 years ago

SODACODE-Issue-Accepted

abs007 commented 2 years ago

Hi, I'd like to contribute to this issue. Could someone please tell me as to where I should be adding the documentation for pycharm? Thanks.

joseph-v commented 2 years ago

Hi, I'd like to contribute to this issue. Could someone please tell me as to where I should be adding the documentation for pycharm? Thanks.

You can update the file delfin/installer/README.md with IDE setup steps

abs007 commented 2 years ago

So should I add documentation about how to install pycharm in the Ubuntu system in the README.md ?

abs007 commented 2 years ago

@joseph-v could you tell me if I should add documentation regarding installation of the pycharm ide in the ubuntu system?

joseph-v commented 2 years ago

This issue is for creating documentation on how to run delfin processes in PyCharm IDE for development process.

Steps can include cloning delfin repository, installing Delfin dependencies (rabbitmq, redis etc), running delfin process with its options in a python virtual environment. (You can refer README.md listed above)

For example, after the steps delfin api.py may be executed as below.

Screenshot from 2022-03-07 18-57-20 .

abs007 commented 2 years ago

Understood. I'll work on this.

abs007 commented 2 years ago

Hi, I actually am encountering this error when running the install file in the installer folder.

Screenshot (34)

joseph-v commented 2 years ago

Can you please re-try the installer with fix in PR https://github.com/sodafoundation/delfin/pull/735

sushanthakumar commented 2 years ago

@abs007 Any luck with this?

abs007 commented 2 years ago

Not really. I've not been able to solve this issue.