Small changes to improve developer experience #6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
You're awesome, thanks for the feedback! Will merge it shortly.👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A few commits to help with this project.
Adding a gitignore so people can more easily use virtualenvs.
Adding a TODO for automated testing, you will want these if you are going to keep this project alive long term.
Removing the duplicate list of packages in the readme. You will just get annoyed having to maintain that over time and people will be fine reading the requirements file. That is the purpose of the requirements file.
The "black" package is a widely used automatic formatting system for python (https://pypi.org/project/black/) use it with the default settings and people will have an easy time matching your code style. It doesn't really have any options anyway, which is what makes it the best one to use.
I have included instructions on how to run it in the readme, but have not run it for your project as it will make small adjustments to most lines of code. As this is your project it is better to keep your name on the commit for the lines you have written.
I'm happy to contribute more on this, particularly if you need input regarding automated tests, but it should be done after the formatting is sorted.