Articles on ymartinez's Blog

Post #6: Final blog post

ybrahimmartinez09@gmail.com (ymartinez) — Fri, 27 Aug 2021 20:19:52 +0000

Hi everyone! this is my final blog post in the 2021 GSoC internship. The journey is almost over, it has been 2 months and I can't believe the fast that was.
Although this is the final post required by PSF, I am planning to create a blog post with more detailed information of my overall experience in this internship, but right now I am sick so I hope that will be the next week you can check my personal blog here.

What are you working on?

The last week I was working on document all my code, and also made a report with my activities in the internship, this report I made in the PyZombis wiki.

What have you struggled with?

As I said before, right now I am sick so, it was difficult for me made this report because I was such tired, and with terrible flu, but I needed to do that requirement, and I did it finally!

Weekly Check-In #6: Tenth Week

ybrahimmartinez09@gmail.com (ymartinez) — Fri, 20 Aug 2021 21:30:47 +0000

Hi everyone! this is the my final weekly check-in in my GSoC internship, if you want to know more about my whole internship, please check out the previous.

The last week was the final of the coding phase, it was a great experience, I learned a lot.

What did you do this week?

Being the last week, I only made reviews of the PR of my colleagues, and additionally, I was finishing the Model View Controler lesson, however, I am still finishing it since during the meeting with my mentors they gave me some suggestions. I hope to finish it in the next week but as a contribution of my own and not part of the code phase.

What is coming up next?

For this week I am going to be working on the report of my activities, this is a requirement to fulfill my last evaluation. I am doing this report on the PyZombis project wiki, hoping that anyone can see my journey, as well as all the activities during this internship.

Did you get stuck anywhere?

Last week I was stuck and I am still stuck in the writing of the lesson since the original course was very basic in this lesson, and since writing is not one of my strengths it has been difficult for me. However, I am progressing in that.

Post #5: Everything almost done

ybrahimmartinez09@gmail.com (ymartinez) — Tue, 10 Aug 2021 23:47:48 +0000

Hi everyone! This is my 5th blog post, and it is the last before the coding phase ends. I can't believe that almost 2 months have passed, the whole experience has been awesome, however, I am going deeper into it in the next post.

Last week I was working on modifying the graphical user interface. This change was necessary to improve the lesson's context, with this information the future students of the course can know more about the interfaces and the basic differences between them. In addition, I changed the initial position of dialogs to the left upper corner, this change helps to a better experience when creating the dialogs. I made a PR with this change and it is awaiting the mentors' review. Below there is a result of this change.

Code


from browser import document, html
from browser.widgets.dialog import Dialog

# Creación de un dialogo con el título
d = Dialog("Show de preguntas Zombis", top=20, left=20)

# Agrega elementos como botones y títulos
d.panel <= html.H3(
    "Aprieta los botones",
    id="titulo_ventana",
    style=dict(textAlign="center")
)
d.panel <= html.BUTTON("Correcto", id="btn_correcto")

d.panel <= html.BUTTON("Incorrecto",
    id="btn_incorrecto",
    style=dict(marginLeft="5em")
)

Result

I made a few Proof of Concepts with different approaches until I found the best solution for my problem, however, one of the approaches that I used was inherited from the Brython class dialog and overwrote the methods that I needed. This approach was the optimal solution but I had a problem, the Brython interpreter did not allow me to do it and I had several issues with this, then I changed it to a simple solution, which can not be optimal, but remember...

Weekly Check-In #5: Eighth Week

ybrahimmartinez09@gmail.com (ymartinez) — Sun, 08 Aug 2021 18:30:01 +0000

Hi everyone! this is the 5th weekly check-in in my GSoC internship journey, if you want to know more about it, please check out the previous.

What did you do this week?

In the 8th week of my internship was working in update the templates files of the project, these files are using when the project is building with Runestone, these changed were proposed before the weekly meeting with my mentors since we had problems when one of my team split the lessons and the core's team of Runestone told her that would be a problem in the templates, so the solution was updated them.

What is coming up next?

The change on the templates files wasn't in my weekly plan, but I know that we would be having issues in the road as with any project...

For that reason, in the next week I was going to work (I already did it, check-out the next post 😜) in modify the graphic user interface lesson to add more context information according to the mentor's review.

Did you get stuck anywhere?

Yes indeed, I had issues when I was updating the files, and I could solve it, replacing all content in the _template folder of the Runestone project with the new ones.

So, Houston we did it!

Post #4: Graphical user Interface

ybrahimmartinez09@gmail.com (ymartinez) — Sun, 25 Jul 2021 23:33:29 +0000

Hello everyone! this is the 4th post of my blog post series to the GSOC internship, you can check out all previous if you want to know more about it :D

At this opportunity, I was working on refactoring the graphical user interface lesson, this lesson in the original course was created using the library to create GUIs tkinter but now I refactored using Brython.

In order to make this change, I used Brython's widgets to create dialogs. This was the way that I found to simulate the behavior of the tkinter library. The result is quite similar, below is a screenshot of the result.

These kinds of dialogs are created using the syntax of Brython and translated to HTML internally using javascript (without use javascript itself), and also you can put any element HTML inside using the same syntaxis, like buttons, input fields (any type), and so on.

I have done a PR that is waiting for my mentors' review, and in the meantime, I am going to work to make reviews of peers' PR and after that, I am going to work in the Model View Controller lesson, which is very important in the second milestone of my internship, so keep going.

Weekly Check-In #4: Sixth Week

ybrahimmartinez09@gmail.com (ymartinez) — Tue, 20 Jul 2021 03:53:05 +0000

Hi everyone! this weekly post could be quick because I didn't have much information to report, however, it is good to maintain the rhythm in blogging.

What did you do this week?

This week I didn't do PR's, my activities were focusing on refactoring the graphic interface lesson of the course, in the original course this lesson was implemented using the libraries tkinter and pygame, but these libraries don't work in runestone so I was searching the best way to implement using the new module of brython

What is coming up next?

I will finish this lesson and after that, focusing on finishing the MVC lesson to finish before the next sprint.

Did you get stuck anywhere?

I didn't, but I needed to searched and understood the brython syntaxis before coding the new lesson structure.

Post #3 : Not all is coding

ybrahimmartinez09@gmail.com (ymartinez) — Tue, 13 Jul 2021 19:01:55 +0000

Hi again! This is my third blog post check out the previos. Also, it is the beginning of the 5th week of the GSoC, that is, the midpoint of my internship, the time passed so fast and it has been a great experience.

During the last week, I was mainly working on two things:

Reorganize my second milestone.

Since in my initial proposal, I established my second milestone using the component raw::HTML of Sphinx and I would create HTML forms to explain in the course PyZombis how MVC works, however, the Brython module was implemented by one of my teammates and now I can implement the lessons of MVC using it. With this module, we can implement and expand lessons and the whole course in general. You can check the new issues that were created here in my project on GitHub.

Code review of teammates' PR's

Not all is coding, in fact, I can sure that most of the time is the second thing that you do during a project, so in this sense make code reviews is a good practice since this maintains order at work, however, not only is code review valuable for this purpose, we use a git-flow from the beginning of the project and an important step is the process of code review each other.

These were my main activities and luckily I didn't have any struggle, however, I had to read the syntaxis and documentation of Brython, because I had to do it if I wanted to update my milestone correctly. This week I am going to work on my first set of issues in order to achieve my goals before finishing the third sprint. In addition, I am going to make the first review of my mentors, the required requirement by the GSoC. With nothing more to report, as Truman said...

Weekly Check-In #3: Fourth Week

ybrahimmartinez09@gmail.com (ymartinez) — Thu, 08 Jul 2021 02:11:51 +0000

Hi again! This is my fourth weekly check-in of my GSoC ‘21 internship in the Python Software Foundation, a little bit late I know but it will be the last time. If it is the first time reading one of my posts about my internship, you could get more information by checking the previous posts of the series.

The last week was finished the second sprint, in the meeting with all team discuss all achievements that we got and we planned how it will the next sprint, before the GSoC's first evaluation. The first evaluation is going to be next week, so this week is important to review all lessons and quizzes for any problems that may be found.

What did you do this week?

As I said in my second blog post I was working on finishing the lessons, this time I only made 2 PRs, but keep in mind that quantity is not meaning quality, so is still valuable if you made 1, 2 or 100 PR's, all is contribution.

What is coming up next?

I was writing this post and I figured out that all the PR's were successfully merged, so with this I finished my first milestone of the internship, so it is great.

Now that I finished it with a week grace, as I said above I am going to review all the lessons and quizzes if I will found a problem I will make a PR to solve it in the meantime also I am going to reformulate my second milestone and the issues taking account the new Brython module created.

Did you get stuck anywhere?

For luck I didn't, I hope to maintain a rhythm like this for the rest of my internship, so see you soon.

Post #2: It's better late than never

ybrahimmartinez09@gmail.com (ymartinez) — Tue, 06 Jul 2021 05:31:28 +0000

Hi again! It's been some days since my last post. This post must have been posted last week, shame on me.

Despite that, it's better late than never. This is the second post of the series posts to my GSoC internship for the Python Software Foundation PSF, if you want to see more about what I am doing this summer check out the previous posts, and I hope that you enjoy them.

That week I was working on finishing the problems in the lessons as I said in the previous post. I didn't know the actual status of them, however, it turned out they didn't have so many problems, but with serious issues of indentation, and code styling. I had done 7 PR's and I want to announce that they have been successfully merged, but they were still waiting for the mentors' review last Monday, with those I just only needed to finish solving an issue to finish my first milestone of the summer before the first evaluation.

Besides that, I forgot in my previous post to tell you that I applied to get a Twitter developer account because for the second milestone maybe it will be great to introduce an exercise using that API. The process was a little tedious since I had to respond to several questions regarding how and why I was going to use the Twitter API, explaining the specific details as much as I could. To summarize, if you want to get one, keep in mind the following inquiries that will be made to you:

The core use case, intent, or business purpose for your use of the Twitter APIs.
If you intend to analyze Tweets, Twitter users, or their content, share details about the analyses you plan to conduct, and the methods or techniques.
If your use involves Tweeting, Retweeting, or liking content, share how you’ll interact with Twitter accounts, or their content.
If you’ll display Twitter content off of Twitter, explain how, and where, Tweets and Twitter content will be displayed with your product or service, including whether Tweets and Twitter content will be displayed at row level, or aggregated.

After of responded to all these inquiries correctly, I received this email:

So I got my Twitter developer account successfully. I am using its API with a Postman collection. I struggled to get my access to the token, but I resolved with the docs page. I could get some tweets from my Twitter account, it was great. This experiment gave me an idea for an exercise to implement in the next milestone. I need to investigate more but I keep an eye on it.

Weekly Check-In #2: Second Week

ybrahimmartinez09@gmail.com (ymartinez) — Sat, 19 Jun 2021 02:00:25 +0000

Hi again! this is my second weekly check-in, you can check the previous one in the series.

The second week of my GSoC internship is finishing and the first sprint as well. In this weekly check-in, I've got the good announcement that my team and I have made great progress during our first sprint. However, there is still a lot of work to do, so let's keep going.

What did you do this week?

I continued work on the quizzes and I made 4 PRs, they are just waiting for the review of my mentors. This is great progress because, with these and the others ones that my teammate did, we have almost finished fixing and refactoring all the quizzes in the PyZombis course.

What is coming up next?

The next week I am going to start with the lessons. As far as I know, there aren't a lot of problems to resolves, however, I need to check out much deeper. I plan to finish all the lessons were assigned to me for the next week so wish me luck.

Did you get stuck anywhere?

Yes indeed, as I said in my first post, at the beginning (check it here), I got stuck using the library playwright. Besides that, I had some conflict problems in a file, but I resolved it by doing rebase. It is very powerful and useful so keep it out there, like an ace up one's sleeve 🧏

Blog Post #1 : Everyone can be struggling with it

ybrahimmartinez09@gmail.com (ymartinez) — Wed, 16 Jun 2021 04:16:21 +0000

Hi again! this is the first blog post that I am writing, the previous was a check-in post. In these posts, I will summarize all the tasks that I will be doing in the GSoC, but without a formal structure so, shall we begin.

The first week was finished and in general, it was great! I had to work in fix some of the problems that the quizzes had with my other teammate, we split all the quizzes to work on the same number of quizzes. In each quiz, I had to fixing and refactoring the exercises following the guidelines of Runestone, ReStructuredText, and PEP8 to Python. In addition, I built tests using the playwright tool, as I said in my previous post, it is a tool to create automatized end-to-end tests, below there is an example and his result.

The code

def test_quiz5_10(page):
    # Go to http://localhost:8000/quiz/Quiz5.html
    page.goto("quiz/Quiz5.html")
    page.wait_for_load_state()

    page.click("text=def es_numero_ponteironuloville(numero):")

    page.press(
        "text=es_numero_ponteironuloville(numero):",
        "ArrowDown"
    )
    page.press("text=es_numero_ponteironuloville(numero):", "Tab")

    page.type(
        "text=es_numero_ponteironuloville(numero):",
        "return True"
    )

    page.click("#q5_10 >> *css=button >> text=Run")

    page.hover("#q5_10 >> text=You passed:")
    assert (
        page.inner_text("#q5_10 >> text=You passed:")
        == "You passed: 50.0% of the tests"
    )

The result of test

I have to say that despite being the first time I use it, it was kind of simple, however, the tests that I built weren't very complicated, but I don't know if this can change in the future 😅 .

At the end of this week, I've done 6 PR's, 5 of which have been merged into the principal branch, and 1 is awaiting review. With these, I've closed 2 issues that were been created previously to achieve my first milestone successfully, so I think that I am going at good steps.

Not all was easy because to ensure the PEP8 guidelines in the Python codes, I had to use black and flake8 but only in the python codes, so I had to extract these portions from the Rst files in another one and save it such as a Python file and after that paste to the Rst files again, it wasn't a hard task however it was very repetitive, but I know that sometimes programming can be like this, the important thing is to keep going.

Another thing that I was struggling with, was a problem that I found and for luck, I resolved it with the command git rebase. I heard about it but I didn't have to use it before. I can assure you, it has too much power even to rewrite the history of git (I will explain later on), although remember as uncle Ben said.

so, we have to be careful to use it 👌

In this case, I used it because in a PR that created I renamed a file, and I fixed the exercises in there, however, for git, what I did was delete that file and create another with the code, and according to one of my mentors, isn't a good coding practice because it is difficult of review it, since you lost all the previous code and the diff shows only new things, for that reason I had to made a new PR only to rename that file, and after this one has been merged, I was able to finish the other one.

Once that was merged I had a huge conflict problem with that file in that PR, so it was time to use the rebase power wisely.

First, I had checkout to the main branch on my local computer, pull all the changes of my remote repository, after that I checkout again to the branch of my changes, and finally rebase this branch with my main branch. This sounds easy, but it was kind of stressful because I had to review each change of all the commits behind HEAD, that is, all the changes that I previously made in that branch, and only after resolving all the conflicts the results were that my changes were successfully added in front of HEAD, as if the previous commits had not existed, so somehow I changed the history of the project in git 🤯.

Weekly Check-In #1 Onboarding Period

ybrahimmartinez09@gmail.com (ymartinez) — Mon, 07 Jun 2021 23:59:35 +0000

The last three weeks were an onboarding time for all interns in the GSoC, and today 7th June is starting the coding phase. Although I don't have experience in writing blogs, sometimes all that we need is to take a leap of faith 😊 so, I will be recording my experience and status on a series of blog posts. Follow me on this journey and I hope that you enjoy it.

What did you do these weeks?

During these weeks I was working on getting familiarized with the Runestone library, and the Playwright library. The first one is a tool to create interactive books in different languages, Python in this case 👍, and the last one is a tool to create automated end-to-end tests on web apps.

In addition, during the onboarding period I had two meetings with the mentors and the entire team, in the first one we met each other and talked about the status of the project, and the mentor merged all PR's that we had created during the application period.

The second meeting with the mentors was more technical and it helped to coordinate how we are going to work on our tasks and schedule bi-weekly meetings following the Scrum methodology. For this, I split my initial proposal into issues and milestones using Github, and for making all organized I put them in a Github project board as well.

What is coming up next?

In the first month of the coding period, I am going to work on my first milestone. More specifically in the next week, I am going to work to fix the current bugs on quizzes, adding an end-to-end test to ensure that everything is ok.

Did you get stuck anywhere?

Not yet, but if this happens I am going to find on the internet solutions and talk with my mentors 😅 and find solutions on the Internet.