tylercrompton / streams Goto Github PK

Delete the stub files when done. Stub files are intended for extension modules and such—not for modules like this.

We'll definitely add support for Python 3.7. We might add support for Python 3.6 too, but it reaches end of life in less than three months, so if there's a reason to want one or more features from Python 3.7, then supporting Python 3.6 might not be worth bothering. That said, end of life in and of itself isn't necessarily a reason to not support it. If supporting it requires little to no additional effort, then we might still support it.

As for implementations, we currently support CPython only, but I'd like to add support for other implementations such as PyPy, IronPython, and Jython. However, think hard about this as we might need to drop support for alternative implementations due to #7.

Stop putting it off and get it taken care of.

The formatting of Sphinx-style docstrings is often inscrutable. Let's convert the docstrings to comply with the Google Python Style Guide. However, we should still comply with PEP 257. PEP 257 should take precedent in any conflicts between it and the Google Python Style Guide. If the Python stub files become entirely redundant, then remove them. For documentation generation, we'll need to add the Sphinx extension sphinx.ext.napoleon. This relates to #5.

This speed of this library might be meaningfully improved if converted to an extension module. However, this would restrict the library to CPython. Additionally, doing so would require nearly an entire rewrite. Weigh the pros and cons and decide if this is a desirable direction in which to take the project. This issue isn't for the rewrite itself—it's just to determine if there should be one.

See https://github.com/yhino/pipenv-poetry-migrate.

See the following pages for more info:

• https://github.com/github/renaming/
• https://sfconservancy.org/news/2020/jun/23/gitbranchname/

Be sure to also mention in README.md that files that are automatically generated and files that can't reasonably have such a notice in it (e.g. JSON files) are also covered by GPLv3. Then, do your best to explicitly list each file to which this applies but state that the list isn't necessarily exhaustive (in case some file(s) get overlooked (now or in the future)).

The name “streams” is already taken, so we'll need to determine the next best name. Be sure to update the documentation to include installation steps.

Modify the docstrings such that they use the rST directive :return:.

Integrate Pylint into the workflow to enforce this as best as possible. Obviously, Pylint won't particularly help with PEP 423.