Re: Python Standardization
Hello Anmol. Gedare covered essentially what this project covers. To add a little further we want to push all the tools behind a common accessible API with the frontend tools being a thin wrapper. This will allow us to have better testing of our tools as well as easing maintenance by encouraging more self consumption and standard Python methods for CLI console, logging and file access -- not limited to just these however. Amar. ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: Python Standardization
On 22/03/2020 14:33, Gedare Bloom wrote: On Sun, Mar 22, 2020 at 7:07 AM Anmol Mishra wrote: Hello, Since you clarified the motivation for API, I need to ask a few questions which will help me. 1. By API, Do you mean a wrapper or a common access point to test/access all the utilities? If yes, Is REST API is expected like a dashboard? 2. Is there any active API? I know this question may seem to be naive but I need to discuss it and clarification is better than any wrong interpretation. All dev members can help me, I will really appreciate it. To get better participation you might want to use a more specific subject line and provide some extra context to your question. The project idea is about defining a uniform/consistent interface for using different products located primarily in rtems-tools.git The project idea ticket says: * A general RTEMS tool library with a standard API to handle common tasks. * All utilities callable as a function within the API with the tool itself being a thin layer. * Testing on all API commands under both Python 2.x and 3.x. API is taken as the original meaning of "application programming interface" to mean how applications will use the tool library. This has nothing to do with web services. I hope that helps with some of your confusion. Many of the "home-grown" RTEMS tools have relatively consistent command line interfaces (CLI), but I can't speak to their API; a lot of them were designed to be used on the command line, which could also be used as an API but it is not efficient because you generally have to invoke the tool in a subprocess in such cases. To identify which modules in rtems-tools are intended to be reusable components you can grep for import statements. This shows for example that the rtemstoolkit is intended to be reused, e.g. grep -r --include='*.py' 'import\s' -h . | grep rtems | sort | uniq -c 5 from rtemstoolkit import check 1 from rtemstoolkit import config 4 from rtemstoolkit import configuration 1 from rtemstoolkit import configuration as configuration_ 30 from rtemstoolkit import error 15 from rtemstoolkit import execute 3 from rtemstoolkit import git 8 from rtemstoolkit import host 17 from rtemstoolkit import log 1 from rtemstoolkit import macros 4 from rtemstoolkit import macros 2 from rtemstoolkit import mailer 1 from rtemstoolkit import options 5 from rtemstoolkit import options 23 from rtemstoolkit import path 2 from rtemstoolkit import reraise 2 from rtemstoolkit import rtems 4 from rtemstoolkit import stacktraces 2 from rtemstoolkit import textbox 1 from rtemstoolkit import version 9 from rtemstoolkit import version 2 import rtems For example rtemstoolkit.error is imported in 30 other modules. This looks like a good candidate to get started with unit testing. Testing the command line tools is also important. We need a good testing framework for this. This usually involves setting up a temporary directory with some defined content. Starting command line tools as subprocesses, capturing the stdout and stderror, inspecting the directory, etc. All this testing work should be accompanied by updates of the Python Guidelines. ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: Python Standardization
On Sun, Mar 22, 2020 at 7:07 AM Anmol Mishra wrote: > > Hello, > Since you clarified the motivation for API, I need to ask a few questions > which will help me. > > 1. By API, Do you mean a wrapper or a common access point to test/access all > the utilities? If yes, Is REST API is expected like a dashboard? > > 2. Is there any active API? > > I know this question may seem to be naive but I need to discuss it and > clarification is better than any wrong interpretation. All dev members can > help me, I will really appreciate it. > To get better participation you might want to use a more specific subject line and provide some extra context to your question. The project idea is about defining a uniform/consistent interface for using different products located primarily in rtems-tools.git The project idea ticket says: * A general RTEMS tool library with a standard API to handle common tasks. * All utilities callable as a function within the API with the tool itself being a thin layer. * Testing on all API commands under both Python 2.x and 3.x. API is taken as the original meaning of "application programming interface" to mean how applications will use the tool library. This has nothing to do with web services. I hope that helps with some of your confusion. Many of the "home-grown" RTEMS tools have relatively consistent command line interfaces (CLI), but I can't speak to their API; a lot of them were designed to be used on the command line, which could also be used as an API but it is not efficient because you generally have to invoke the tool in a subprocess in such cases. > Regards > Anmol ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Python Standardization
Hello, Since you clarified the motivation for API, I need to ask a few questions which will help me. 1. By API, Do you mean a wrapper or a common access point to test/access all the utilities? If yes, Is REST API is expected like a dashboard? 2. Is there any active API? I know this question may seem to be naive but I need to discuss it and clarification is better than any wrong interpretation. All dev members can help me, I will really appreciate it. Regards Anmol ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
RTEMS Python Standardization
Hello, I know you might be consumed in some work, But can you please clarify a few things or some other developer from the community. Please explain a bit about "The entire API will need to be tested using pytest" and your feedback on https://docs.google.com/document/d/1_G0-q7J2b-5kJzZGI32a-KpC6gMzJ1FcNFFTdMCw1c4/edit?usp=sharing is appreciated, However, Dr. Gedare has given me some insights, your insights are equally valuable to me. Waiting for your reply. Thanks and Regards Anmol ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: RTEMS Python Standardization (ticket #3892)
Hello, I put your email in cc, Did you get a chance to take a quick read of my shared proposal? In case you missed it, https://docs.google.com/document/d/1_G0-q7J2b-5kJzZGI32a-KpC6gMzJ1FcNFFTdMCw1c4/edit?usp=sharing (This is the link for the first draft). I just need a direction about the point of starting like which repositories to focus first. Your mentorship and help are highly appreciated. Regards Anmol On Thu, Mar 12, 2020 at 8:23 PM Amar Takhar wrote: > On 2020-03-12 11:52 +0530, Anmol Mishra wrote: > > Hello, > > With whom can I discuss regarding douts, Any tentative mentor open for > guiding > > me, I have a few doubts regarding the project. Is Dr. Gedare going to be > a > > tentative mentor? > > I am the mentor for this project. Can you please send any inquiries to > devel@rtems.org? You can sign up for the lists here: > https://lists.rtems.org/ > > Thank you! > > > Amar. > ___ > devel mailing list > devel@rtems.org > http://lists.rtems.org/mailman/listinfo/devel ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: RTEMS Python Standardization (ticket #3892)
On 2020-03-12 11:52 +0530, Anmol Mishra wrote: > Hello, > With whom can I discuss regarding douts, Any tentative??mentor open for > guiding > me, I have a few doubts regarding the project. Is Dr. Gedare going to be a > tentative??mentor? I am the mentor for this project. Can you please send any inquiries to devel@rtems.org? You can sign up for the lists here: https://lists.rtems.org/ Thank you! Amar. ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: RTEMS Python Standardization (ticket #3892)
On Thu, Mar 12, 2020 at 12:22 AM Anmol Mishra wrote: > > Hello, > With whom can I discuss regarding douts, Any tentative mentor open for > guiding me, I have a few doubts regarding the project. Is Dr. Gedare going to > be a tentative mentor? > No, I won't be. I oversee all projects, and try to provide guidance/structure and make sure proposals are sufficiently detailed for us to evaluate. Amar is the most likely potential mentor on this project and should be engaged to get technical direction/advice. The mailing list is also preferred for most communication unless of a personal nature. > Best Regards > > On Tue, Mar 10, 2020 at 11:12 AM Anmol Mishra wrote: >> >> Sure thing, I have replied and reviewed all your comments. Working on them >> and I will restructure it at the earliest. Now I understand google's idea to >> get it reviewed by mentors asap, so that reshaping can be done to match the >> target in time. >> >> Thanks for your input and time. >> >> Best Regards >> >> On Tue, Mar 10, 2020 at 3:18 AM Gedare Bloom wrote: >>> >>> Hello Anmol, >>> >>> I have provided some feedback on your draft. Please focus on reshaping >>> your proposal to provide a stronger organization of both your thought >>> process and your plan for working in the summer. You might like to >>> review advice in: https://google.github.io/gsocguides/student/ >>> >>> On Mon, Mar 9, 2020 at 12:02 PM Anmol Mishra wrote: >>> > >>> > Hello, >>> > I proposed the project and after a lot of input, I saw that a project >>> > RTEMS Python Standardization (ticket #3892) has been added to the list. >>> > I have drafted a proposal (It needs a lot of refinement and I seek from >>> > expected mentor and co-mentor in this step) >>> > >>> > https://docs.google.com/document/d/1_G0-q7J2b-5kJzZGI32a-KpC6gMzJ1FcNFFTdMCw1c4/edit?usp=sharing >>> > >>> > Please consider me a little naive as this is my first proposal, I will >>> > try to match the benchmark in the final proposal, A lot of discussions is >>> > to be done at this stage. >>> > >>> > Best Regards >>> > Anmol Mishra ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: RTEMS Python Standardization (ticket #3892)
Hello, With whom can I discuss regarding douts, Any tentative mentor open for guiding me, I have a few doubts regarding the project. Is Dr. Gedare going to be a tentative mentor? Best Regards On Tue, Mar 10, 2020 at 11:12 AM Anmol Mishra wrote: > Sure thing, I have replied and reviewed all your comments. Working on them > and I will restructure it at the earliest. Now I understand google's idea > to get it reviewed by mentors asap, so that reshaping can be done to match > the target in time. > > Thanks for your input and time. > > Best Regards > > On Tue, Mar 10, 2020 at 3:18 AM Gedare Bloom wrote: > >> Hello Anmol, >> >> I have provided some feedback on your draft. Please focus on reshaping >> your proposal to provide a stronger organization of both your thought >> process and your plan for working in the summer. You might like to >> review advice in: https://google.github.io/gsocguides/student/ >> >> On Mon, Mar 9, 2020 at 12:02 PM Anmol Mishra >> wrote: >> > >> > Hello, >> > I proposed the project and after a lot of input, I saw that a project >> RTEMS Python Standardization (ticket #3892) has been added to the list. >> > I have drafted a proposal (It needs a lot of refinement and I seek from >> expected mentor and co-mentor in this step) >> > >> > >> https://docs.google.com/document/d/1_G0-q7J2b-5kJzZGI32a-KpC6gMzJ1FcNFFTdMCw1c4/edit?usp=sharing >> > >> > Please consider me a little naive as this is my first proposal, I will >> try to match the benchmark in the final proposal, A lot of discussions is >> to be done at this stage. >> > >> > Best Regards >> > Anmol Mishra >> > ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: RTEMS Python Standardization (ticket #3892)
Sure thing, I have replied and reviewed all your comments. Working on them and I will restructure it at the earliest. Now I understand google's idea to get it reviewed by mentors asap, so that reshaping can be done to match the target in time. Thanks for your input and time. Best Regards On Tue, Mar 10, 2020 at 3:18 AM Gedare Bloom wrote: > Hello Anmol, > > I have provided some feedback on your draft. Please focus on reshaping > your proposal to provide a stronger organization of both your thought > process and your plan for working in the summer. You might like to > review advice in: https://google.github.io/gsocguides/student/ > > On Mon, Mar 9, 2020 at 12:02 PM Anmol Mishra > wrote: > > > > Hello, > > I proposed the project and after a lot of input, I saw that a project > RTEMS Python Standardization (ticket #3892) has been added to the list. > > I have drafted a proposal (It needs a lot of refinement and I seek from > expected mentor and co-mentor in this step) > > > > > https://docs.google.com/document/d/1_G0-q7J2b-5kJzZGI32a-KpC6gMzJ1FcNFFTdMCw1c4/edit?usp=sharing > > > > Please consider me a little naive as this is my first proposal, I will > try to match the benchmark in the final proposal, A lot of discussions is > to be done at this stage. > > > > Best Regards > > Anmol Mishra > ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: RTEMS Python Standardization (ticket #3892)
Hello Anmol, I have provided some feedback on your draft. Please focus on reshaping your proposal to provide a stronger organization of both your thought process and your plan for working in the summer. You might like to review advice in: https://google.github.io/gsocguides/student/ On Mon, Mar 9, 2020 at 12:02 PM Anmol Mishra wrote: > > Hello, > I proposed the project and after a lot of input, I saw that a project RTEMS > Python Standardization (ticket #3892) has been added to the list. > I have drafted a proposal (It needs a lot of refinement and I seek from > expected mentor and co-mentor in this step) > > https://docs.google.com/document/d/1_G0-q7J2b-5kJzZGI32a-KpC6gMzJ1FcNFFTdMCw1c4/edit?usp=sharing > > Please consider me a little naive as this is my first proposal, I will try to > match the benchmark in the final proposal, A lot of discussions is to be done > at this stage. > > Best Regards > Anmol Mishra ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
RTEMS Python Standardization (ticket #3892)
Hello, I proposed the project and after a lot of input, I saw that a project RTEMS Python Standardization (ticket #3892) has been added to the list. I have drafted a proposal (It needs a lot of refinement and I seek from expected mentor and co-mentor in this step) https://docs.google.com/document/d/1_G0-q7J2b-5kJzZGI32a-KpC6gMzJ1FcNFFTdMCw1c4/edit?usp=sharing Please consider me a little naive as this is my first proposal, I will try to match the benchmark in the final proposal, A lot of discussions is to be done at this stage. Best Regards Anmol Mishra ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
