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

feat: implement console ext #1287

Merged
merged 4 commits into from
Feb 28, 2023
Merged

feat: implement console ext #1287

merged 4 commits into from
Feb 28, 2023

Conversation

LordOfPolls
Copy link
Contributor

About

This PR adds a new extension called "console" to the builtin collection. The Console extension allows users to start the bot with the aiomonitor console active, which provides a REPL for the bot.

To access the console, users can connect to the port specified in the constructor (by default, port 501). On Linux, users can do this with nc localhost 501, while on Windows they can use telnet localhost 501. Alternatively, users can also use python -m aiomonitor.cli -p 501 on both platforms.

Checklist

  • The pre-commit code linter has been run over all edited files to ensure the code is linted.
  • I've ensured the change(s) work on 3.8.6 and higher.
  • I have added the versionadded, versionchanged and deprecated to any new or changed user-facing function I committed.

Pull-Request specification

I've made this pull request: (check all that apply)

  • For the documentation
  • To add a new feature
  • As a general enhancement
  • As a refactor of the library/the library's code
  • To fix an existing bug
  • To resolve #ISSUENUMBER

This is:

  • A breaking change

@LordOfPolls LordOfPolls added the enhancement New feature or request label Feb 25, 2023
@codecov-commenter
Copy link

codecov-commenter commented Feb 25, 2023

Codecov Report

Base: 48.28% // Head: 48.22% // Decreases project coverage by -0.06% ⚠️

Coverage data is based on head (b42becd) compared to base (867ed5a).
Patch coverage: 0.00% of modified lines in pull request are covered.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@            Coverage Diff             @@
##              5.x    #1287      +/-   ##
==========================================
- Coverage   48.28%   48.22%   -0.06%     
==========================================
  Files         136      137       +1     
  Lines       13779    13796      +17     
==========================================
  Hits         6653     6653              
- Misses       7126     7143      +17     
Impacted Files Coverage Δ
interactions/ext/console.py 0.00% <0.00%> (ø)
setup.py 0.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

pyproject.toml Outdated Show resolved Hide resolved
Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com>
@LordOfPolls LordOfPolls merged commit bffc1cf into 5.x Feb 28, 2023
@LordOfPolls LordOfPolls deleted the aioconsole_ext branch February 28, 2023 08:04
LordOfPolls added a commit that referenced this pull request Mar 13, 2023
* feat: implement console ext

* style: linter pass

* ci: correct from checks.

* Update pyproject.toml

Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants