-
Notifications
You must be signed in to change notification settings - Fork 88
PSF Grant application
Written in March 2019
PEP 8 Speaks is an open source project[1] and a free service[2] which reviews the Python code style over GitHub Pull Requests. The project is two years old but has been growing rapidly in the past six months. I am the maintainer of the project and I am still a student with no source of income until next year. There is no scheduled date which mandates receiving the funds. Donation from PSF for hosting the service for one year would help a lot and will support the development of the project.
Maintainers of Python projects have a difficult time reviewing Pull Requests by new contributors who may not be aware of the code style. Due to code style issues hidden in CI logs, they are often overlooked when accepting new contributions. This project makes reviewing Pull Requests a little bit easier by reviewing the Pull Request for code style issues.
The project is constantly under development with additions and modifications of features. Users report back with suggestions and "feature requests" which helps in shaping the future of the project. Check out the list of open issues on GitHub to understand where this project is headed and the list of closed issues and Pull Requests to see how it has evolved.
[1] https://github.com/OrkoHunter/pep8speaks [2] https://pep8speaks.com
$90 total ($84 hosting charges for one year, and other transaction charges by Paypal)
Heroku (current hosting provider) allows a certain number of free hosting hours. However, with the increasing number of users and webhook payloads to the server, this would not be possible. As of February 2019, PEP 8 Speaks needs a paid Heroku host (dyno) for the last two days of the month, due to the exhaustion of free hours. Additional funds allow the use of developer tools (logging services, etc.) on the server to aid the debugging process, which is very time-consuming as of now. Future plans include supporting Gitlab and Bitbucket platforms as well, which would significantly include server load and make it extremely difficult to run on free Heroku accounts. Minimum funds required for hosting this project is $7 per month.
To thank Python Software Foundation for the sponsorship, we will place the PSF logo and the website in the Project README and the project website. Link to PSF will be added in @pep8speaks's[1] GitHub bio.
[1] https://github.com/pep8speaks
The grant will be received by me, which I will use to pay for hosting the service. However, I would like to add that hosting the service benefits all the Python projects which directly use the service.
A total of 1200+ projects, 111 Organizations and 175 individual maintainers use the service. Popular users include the organizations Pandas, Scikit Image, Scikit Learn Contrib, Spyder IDE, Pydata (for the xarray project), Astronomy organizations like Astropy and Sunpy, Mycroft AI. You can check out the complete list of organizations and individual maintainers[1].
[1] https://github.com/OrkoHunter/pep8speaks/wiki/List-of-users-and-orgs
PEP 8 Speaks is a creative way in which organizations are working on the Python code style. Due to the pep8speaks, I get to interact with a lot of users and discussions about the Python code style. I will compile all the instances and create a blog post where I will analyze how different Python projects are working upon their code style and how PEP 8 Speaks benefit them.
Paid hosting will enable me to store the logs, reduce response time, find more bugs and fix them. I will publish blog posts about the development process and things I learn while maintaining the project.