Contributing To PyFarm¶
PyFarm is a Python based project with the goal of creating an easy to use and deploy render farm. The project is written on top of several existing libraries including SQLAlchemy, Flask, Twisted, and many more. While PyFarm’s original goal is providing the base for running a render farm it can be used for other types of work as well.
As flexible and easy to use as the project may be, contributions from the community are always welcome. There are many ways one can contribute to the overall project but generally they fall under either documentation, bug fixes, features, or testing. With that in mind, if you’re looking to contribute to any of these three areas then read on to get started.
Below are some resources which are for developers wishing to contribute to PyFarm.
- Coding Style
- Basic Syntax Considerations
- HTTP Endpoints
- Exceptions and Errors
- Platform Specific Code
- Supporting Multiple Python Versions
The project is broken down into several smaller sub-projects to aid in long
term maintenance and isolation of code scope. Generally speaking there are two
kinds of sub-projects, supporting and operational.
support all consumers of the project in some capacity (ex. documentation or
Operations sub-projects contain the code which operate
PyFarm (ex. agent or master). See the below table to get familiar with the
various sub-projects as they will be referenced later on: