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

Select linters & project logo. #9

Merged
merged 12 commits into from
Mar 30, 2022
Merged

Select linters & project logo. #9

merged 12 commits into from
Mar 30, 2022

Conversation

Prikalel
Copy link
Contributor

Solve https://github.com/KH9IZ/task_tree_local/issues/7
Add steps to run linters on your repo local copy.

@Prikalel Prikalel mentioned this pull request Mar 28, 2022
@Prikalel Prikalel added the enhancement New feature or request label Mar 28, 2022
@Prikalel Prikalel requested a review from KH9IZ March 28, 2022 21:48
@KH9IZ
Copy link
Member

KH9IZ commented Mar 29, 2022

There is no need to breed entities. I thought that would be one - two config files with configs for pylint and pydocstyle.
Not directory with about 10 linters and separate shell script and even README for that.

Github actions is pretty good, by the way!

Velikiy Prikalel added 2 commits March 29, 2022 16:51
* Solve TODO. Add link to the issue of 'Task-Reaction system'.

(cherry picked from commit 80d04f7)
@Prikalel
Copy link
Contributor Author

There is no need to breed entities. I thought that would be one - two config files with configs for pylint and pydocstyle. Not directory with about 10 linters and separate shell script and even README for that.

Github actions is pretty good, by the way!

Please, review the request.
I have deleted 10 linters and add just 2.
Black for autoformatting and pylama which is (suddenly!) the wrapper around all other that I used before.
we have the issue for pylama (see klen/pylama#214 ) so I added the patch that will fix the problem.

Also fix github action so before using pylama it will patch the package.

@Prikalel
Copy link
Contributor Author

I will add documentation to the README about our linters, so, please, review it and do not merge, until I fix README.

@Prikalel Prikalel added the wontfix This will not be worked on label Mar 29, 2022
@Prikalel Prikalel added documentation Improvements or additions to documentation and removed wontfix This will not be worked on labels Mar 29, 2022
@Prikalel Prikalel changed the title Code checkers, linters & github ci settings. Code checkers, linters & project logo. Mar 29, 2022
@Prikalel
Copy link
Contributor Author

Ok, we decided to use black and pylint and do not use CI.
Also I changed the logo as mentioned here #3.

@Prikalel
Copy link
Contributor Author

Ok, we finally decided to use pydocstyle & pylint.
See configuration file for pylint in the root directory.

@Prikalel
Copy link
Contributor Author

Now to run checkers you should use:

python -m pylint --rcfile=.pylintrc --py-version=3.8 $(git ls-files '*.py')
python -m pydocstyle --convention=google $(git ls-files '*.py')

Currently now they do not throw any erros.

P.S. Of cource, I added these instructions to the README.

* We will save our tests in `tests` folder.
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It think we should use last 3.10 version of python

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahah, we actually should use 3.6, you know...IMG_20220330_121717.jpg

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It think we should use last 3.10 version of python

Last version is cool, but there are people, who do not follow last news. So, they have, for example 3.6 version, but some new features in 3.10 will not work in 3.6. That is why these people will not upgrade the python on their machines just for one package. I'm sure we should use not laster version than 3.8.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seams strange for me to use older python, because most servers use 3.6. Because project development on older python partially forces users not to update they're python. Also many client machines run 3.8 now, because recent distros support it.

@KH9IZ KH9IZ merged commit cd0f00d into Chauss-LLC:master Mar 30, 2022
@Prikalel Prikalel changed the title Code checkers, linters & project logo. Select linters & project logo. Apr 3, 2022
@Prikalel Prikalel mentioned this pull request Apr 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants