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

Pyright needs to be added to 'dev-install' make instruction. #22

Closed
synchronizing opened this issue Feb 19, 2021 · 3 comments
Closed

Pyright needs to be added to 'dev-install' make instruction. #22

synchronizing opened this issue Feb 19, 2021 · 3 comments

Comments

@synchronizing
Copy link
Collaborator

synchronizing commented Feb 19, 2021

Unsure how one would go about this, but the NPM package pyright needs to be added to the dev-install Makefile instruction. Simply doing npm install -g pyright will not suffice as Mac and Linux users require sudo, and it would be unknown whether or not the user has npm installed to begin with.

My best guess is documenting this is the best way around this. Opening issue as a form of discussion.

@aliev
Copy link
Owner

aliev commented Feb 20, 2021

actually pyrights is only needed for CI in our case:

https://github.com/aliev/aioauth/blob/master/.github/workflows/python-package.yml#L38

If you are using vscode, it will already be installed after installing the official Python extension from Microsoft. so no need to run make lint from command line.

We can also think about removing pyright from make lint and add it only to CI.

Documenting is also good idea, i think for type checking locally someone might prefer mypy.

@synchronizing
Copy link
Collaborator Author

actually pyrights is only needed for CI in our case:

https://github.com/aliev/aioauth/blob/master/.github/workflows/python-package.yml#L38

Roger that.

If you are using vscode, it will already be installed after installing the official Python extension from Microsoft. so no need to run make lint from command line.

I have it installed, but it was causing some unwarranted issues on my Mac due to it not being globally installed. Was just documenting the case on Issues so I didn't forget.

We can also think about removing pyright from make lint and add it only to CI.

That's a design choice that is up to you. :)

Documenting is also good idea, i think for type checking locally someone might prefer mypy.

For sure- I'll be sure to add it on #21 under Contributing.

@synchronizing synchronizing linked a pull request Mar 1, 2021 that will close this issue
9 tasks
@synchronizing synchronizing mentioned this issue Mar 1, 2021
9 tasks
@aliev
Copy link
Owner

aliev commented Aug 1, 2021

@synchronizing I'm closing this issue since I migrated project to mypy :)

@aliev aliev closed this as completed Aug 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants