naveenkumarreddy8 / chillboss Goto Github PK

Is your feature request related to a problem? Please describe.
Add figlet which shows the Package name when ran.

Describe the solution you'd like
It would be good to see if the user can see the figlet displaying the package name.

Describe alternatives you've considered
We could use Pyfiglet to get the work done.

Is your feature request related to a problem? Please describe.
Create markdown documentation for the repo and it's usage with a few examples with screenshots.

Is your feature request related to a problem? Please describe.
A code can be called a well maintainable if the documentation is perfect. Please add doc strings for the happyboss

Describe the solution you'd like
Use doc strings for everywhere possible. Google style of docstrings is recommendable.

Describe alternatives you've considered
ReSt or any doc strings format is considerable.

Additional context
Based on the docstrings, we could develop sphinx documentation, which is of great help.

Prepare for Release 0.4.0

Is your feature request related to a problem? Please describe.
Please have the sphinx added to build the documentation/host.

Describe the solution you'd like
Setup sphinx for documentation. Napoleon plugin could be used if docstring style is Google

Is your feature request related to a problem? Please describe.
Action for Pypi release.

Describe the solution you'd like
It would be great if we could release the package through Github actions to PyPi.

Describe alternatives you've considered
Manual publish is possible as an alternative.

Additional context
N/A

Please have the logging added to happyboss.
Have a research before head starting implementation on the format of logging.

It would be better if we could provide Verbose level logging viewable by the user(--v tag) to monitor the debug logs.
Would be appreciable if the log messages are in colored format based on the log level:
debug: white
info: blue
warning: yellow
error: red
critical: red

Make chillboss as an executable via Poetry's script tag

Is your feature request related to a problem? Please describe.
Please add metrics for the repo using badges for code coverage, latest release, builds result, hits etc..

Describe the solution you'd like
Try using github actions for the same.

Is your feature request related to a problem? Please describe.
A I want to quickly run ChillBoss with metavariables.

Describe the solution you'd like
A Add the metavars for click command line arguments.

Is your feature request related to a problem? Please describe.
Configure to get the code test coverage for pytest to target the happyboss/. The configuration could be set in pyproject.toml

Describe the solution you'd like
poetry run pytest --cov should show the coverage of happyboss/ only
Try using pytest-cov[toml]

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Is your feature request related to a problem? Please describe.
Disable the failsafe to avoid unwanted pyautogui scenarios caused during moveTo operations.

Describe the solution you'd like
Pass a command line tag --disable-failsafe, a boolean value, which disables the Pyautogui's failsafe.

Update the gif for installation and usage and host it.
Update the readme before release 0.2.0
Update the docs page as well.

Add homepage url in pyproject.toml
check the homepage by having the deployment through feature or develop branch.

Describe the bug
UT coverage should be improved for a few modules

To Reproduce
Steps to reproduce the behavior:

1. poetry run pytest --cov=happyboss

Output:

----------- coverage: platform linux, python 3.7.4-final-0 -----------
Name                     Stmts   Miss  Cover
--------------------------------------------
happyboss/__init__.py        3      0   100%
happyboss/__main__.py       11     11     0%
happyboss/constants.py       0      0   100%
happyboss/move.py           51      1    98%
--------------------------------------------
TOTAL                       65     12    82%

Expected behavior
Target for 100% coverage.