This week was a fantastic experience. I travelled to Toronto to attend the UCOSP code sprint at Mozilla. I got to meet the other students contributing to the Freeseer project, as well as all students participating in UCOSP. We were also given a tour of the Mozilla building, and given a very inspirational talk about considering the importance of what we create as software developers. All in all it was a fantastic weekend and I am grateful once again for UCOSP covering most of my costs.
Here's what I got accomplished this week:
What I worked on this week:
This week I continued my refactoring of the REST server. Now all methods specific to recording endpoints live in the recording.py module, and methods meant to be shared by all api endpoints live in the server.py module. At this point, the REST server has the same functionality as the it did when developed by bohnje, however, it has been decoupled significantly, and as a result is much more modular. This will make the development of new apis much easier.
Now each API is separated logically and contained in a "Blueprint" which is an object that allows us to extend the REST server app object with functions and endpoints pertaining to that specific API. For example, in the recording api, the functions called to set up and teardown the recording api endpoints is contained in the recording.py Blueprint object, and will fire on the first call to the REST server automatically.
Furthermore, I got a number of comments from Thanh Ha and Michael Tom-Wing about style issues, which resulted in some more changes. I've taken note of their comments and will make more of an effort to follow the PEP8 and Google Python Style guides.
I had a great conversation with Freeseer mentor Joe Yeung about what I should work on for the rest of the UCOSP program. While I was considering developing a GUI Client for the REST server, Joe pointed out that there is still a lot more work that needs to be done on the REST server before we start thinking about clients.
Next week:
For next week, (this week really), I will be writing my project proposal. Essentially, I am going to research best practices for RESTful services, and see what needs to be added to our REST server as a result. Joe pointed out that at the very least, we need to implement some form of authentication, but my research will also point out other things that need to be implemented or improved.
Now each API is separated logically and contained in a "Blueprint" which is an object that allows us to extend the REST server app object with functions and endpoints pertaining to that specific API. For example, in the recording api, the functions called to set up and teardown the recording api endpoints is contained in the recording.py Blueprint object, and will fire on the first call to the REST server automatically.
Furthermore, I got a number of comments from Thanh Ha and Michael Tom-Wing about style issues, which resulted in some more changes. I've taken note of their comments and will make more of an effort to follow the PEP8 and Google Python Style guides.
I had a great conversation with Freeseer mentor Joe Yeung about what I should work on for the rest of the UCOSP program. While I was considering developing a GUI Client for the REST server, Joe pointed out that there is still a lot more work that needs to be done on the REST server before we start thinking about clients.
Next week:
For next week, (this week really), I will be writing my project proposal. Essentially, I am going to research best practices for RESTful services, and see what needs to be added to our REST server as a result. Joe pointed out that at the very least, we need to implement some form of authentication, but my research will also point out other things that need to be implemented or improved.
No comments:
Post a Comment