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

Add orjson to requirements #102

Closed
wants to merge 1 commit into from

Conversation

teddyrasmussen
Copy link

@teddyrasmussen teddyrasmussen commented Jun 14, 2022

Description

This is a very simple change that just adds the package orjson to the requirements, as it is a requirement and was not previously included.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

No tests are really needed for this, but I did uninstall all the dependencies & antispam itself, and I didn't have to install orjson when I installed the antispam requirements before antispam itself.

Checklist:

  • I have added in logging for all relevant areas
  • I have performed a self-review of my own code
  • My code follows the style guidelines of this project
  • New and existing unit tests pass locally with my changes
  • I have made corresponding changes to the documentation
  • I have commented my code, particularly in hard-to-understand areas
  • I have added tests that prove my fix is effective or that my feature works

@Skelmis
Copy link
Owner

Skelmis commented Jun 14, 2022

I'm not sure how so?
orjson is not required, or should not be required outside of the redis cache. If a user wishes to use the library with redis, they can install it as so with discord-anti-spam[redis] which installs the relevant requirements. Although I do agree this could likely be clearer.

@Skelmis Skelmis added the question Further information is requested label Jun 14, 2022
@coveralls
Copy link

coveralls commented Jun 14, 2022

Pull Request Test Coverage Report for Build 2497412928

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.201%

Totals Coverage Status
Change from base Build 2495782368: 0.0%
Covered Lines: 1530
Relevant Lines: 1574

💛 - Coveralls

@teddyrasmussen
Copy link
Author

Thanks for adding on to that, I had no idea that you had to do that. Although I'm not entirely sure what your vision for the docs is, I didn't see this anywhere in them. This might be a good thing to add to the corresponding docs.

@teddyrasmussen
Copy link
Author

teddyrasmussen commented Jun 15, 2022

Update to my earlier message:
Apparently, PyPI thinks that there is no redis extra, even though it is in the setup.py.

Collecting discord-anti-spam[redis]
  Using cached Discord_Anti_Spam-1.4.0-py3-none-any.whl (100 kB)
WARNING: discord-anti-spam 1.4.0 does not provide the extra 'redis'
Requirement already satisfied: attrs in ./venv/lib/python3.10/site-packages (from discord-anti-spam[redis]) (21.4.0)
Requirement already satisfied: fuzzywuzzy>=0.18 in ./venv/lib/python3.10/site-packages (from discord-anti-spam[redis]) (0.18.0)
Installing collected packages: discord-anti-spam
Successfully installed discord-anti-spam-1.4.0

@Skelmis
Copy link
Owner

Skelmis commented Jun 15, 2022

Thanks for adding on to that, I had no idea that you had to do that. Although I'm not entirely sure what your vision for the docs is, I didn't see this anywhere in them. This might be a good thing to add to the corresponding docs.

Correct.

And yes, looks like somewhere since I first released this package the extras part has broken, #105

@Skelmis Skelmis added wontfix This will not be worked on and removed question Further information is requested labels Jun 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants