Add Complete Tutorials #53

rajkumardongre · 2023-08-10T19:20:28Z

No description provided.

milancurcic

Thank your for this PR, @rajkumardongre, great progress.

Only tiny formatting nit-picks for now:

tuotrial.md -> tutorial.md
Don't bold the text in the headings
real_proj -> I suggest just "mini-project" or "example-project"

I will take some time to go through the tutorial and test that everything works.

jvdp1

LGTM. It is easy to follow and repeat.

jvdp1 · 2023-08-10T22:16:34Z

tutorial/real_proj/github-org-analyzer.md

+fpm build
+```
+
+### **Step 5: Import the Libraries**


Suggested change

### **Step 5: Import the Libraries**

### **Step 4: Import the Libraries**

jvdp1 · 2023-08-10T22:17:12Z

tutorial/real_proj/github-org-analyzer.md

+
+* `to_string` : We use this function to convert integers to their string representations
+
+### **Step 6: Create the `print_org_repositories` Subroutine**


Suggested change

### **Step 6: Create the `print_org_repositories` Subroutine**

### **Step 5: Create the `print_org_repositories` Subroutine**

jvdp1 · 2023-08-12T19:28:20Z

README.md

+
+* **[foropenai](https://github.com/gha3mi/foropenai):** A Fortran library for OpenAI API.
+
+    *~By [AliG (gha3mi)](https://github.com/gha3mi)*


What does this library?

The primary purpose of this project is to facilitate interaction with the OpenAI API. To achieve this, the project is using http package for making API calls.

jvdp1 · 2023-08-12T19:29:37Z

tutorial/real_proj/github-org-analyzer.md

+
+# **Prerequisite** 🚩
+
+Before building the GitHub Organization Analyzer library and running the program, you need to ensure that you have [`fpm`](https://fpm.fortran-lang.org/) (Fortran Package Manager) installed. Additionally, there is one dependency required for the [`http-client`](https://github.com/fortran-lang/http-client) library used in the project. Follow the steps below to set up your environment:


Mention the minimum version of fpm also here.

jvdp1 · 2023-08-12T19:30:27Z

tutorial/real_proj/github-org-analyzer.md

+
+### **Step 2: Install libcurl Development Headers**
+
+The `http-client` library, requires the libcurl development headers to be installed. On Ubuntu-based systems, you can install the required dependencies using the following command:


Suggested change

The `http-client` library, requires the libcurl development headers to be installed. On Ubuntu-based systems, you can install the required dependencies using the following command:

The `http-client` library requires the libcurl development headers to be installed. On Ubuntu-based systems, you can install the required dependencies using the following command:

jvdp1 · 2023-08-12T19:31:07Z

tutorial/real_proj/github-org-analyzer.md

+
+### **Step 2: Install libcurl Development Headers**
+
+The `http-client` library, requires the libcurl development headers to be installed. On Ubuntu-based systems, you can install the required dependencies using the following command:


Maybe:

Suggested change

The `http-client` library, requires the libcurl development headers to be installed. On Ubuntu-based systems, you can install the required dependencies using the following command:

The `http-client` library, requires the ``libcurl`` development headers to be installed. On Ubuntu-based systems, you can install the required dependencies using the following command:

?

jvdp1 · 2023-08-12T19:32:45Z

tutorial/real_proj/github-org-analyzer.md

+
+1. Open your terminal or command prompt and create a new directory for the project:
+
+```


Suggested change

```

```bash

??

jvdp1 · 2023-08-12T19:33:33Z

tutorial/real_proj/github-org-analyzer.md

+### **Step 3: Build the Project**
+
+Run the following command to build the project:
+
+```
+fpm build
+```


Is this step really needed here?

In my understanding, when executing the fpm run command, the project will be built automatically during that process. Therefore, it seems unnecessary to include a separate step for building the project. So Should I remove this step?

jvdp1 · 2023-08-12T19:38:52Z

tutorial/real_proj/github-org-analyzer.md

+         call json%get('['//count//'].name', value, found)
+
+         ! Enter the loop to traverse all repositories while they exist
+         do while(found)


This loop is strange. Does it call twice json%get for the same count? Why is the last json%get needed?

jvdp1 · 2023-08-12T19:50:43Z

tutorial/real_proj/github-org-analyzer.md

+         ! Traverse Repositories and Print Names
+
+         ! Counter to traverse all repos one by one
+         i = 1
+
+         ! Storing the string equivalent of i in the count variable
+         count = to_string(i)
+
+         ! Fetching the name of the 1st GitHub repository, if it exists (found is set to true)
+         call json%get('['//count//'].name', value, found)
+
+         ! Enter the loop to traverse all repositories while they exist
+         do while(found)
+
+            ! Fetch the name of the current repository (based on the `i` counter) and check if it exists
+            call json%get('['//count//'].name', value, found)
+
+            ! If the repository name exists (`found` is true), print the repository number and name
+            if (found) then
+               print *, count//'. ', value
+            end if
+
+            ! Increment the counter for the next repository
+            i = i + 1
+
+            ! Convert the updated counter to its string representation and store it in count variable
+            count = to_string(i)
+
+            ! Fetch the name of the next repository (based on the updated `i` counter) and update `found` accordingly
+            call json%get('['//count//'].name', value, found)
+
+         end do


Here is a suggestion (with a single call to json%get) that looks easier to understand (at least to me):

Suggested change

! Traverse Repositories and Print Names

! Counter to traverse all repos one by one

i = 1

! Storing the string equivalent of i in the count variable

count = to_string(i)

! Fetching the name of the 1st GitHub repository, if it exists (found is set to true)

call json%get('['//count//'].name', value, found)

! Enter the loop to traverse all repositories while they exist

do while(found)

! Fetch the name of the current repository (based on the `i` counter) and check if it exists

call json%get('['//count//'].name', value, found)

! If the repository name exists (`found` is true), print the repository number and name

if (found) then

print *, count//'. ', value

end if

! Increment the counter for the next repository

i = i + 1

! Convert the updated counter to its string representation and store it in count variable

count = to_string(i)

! Fetch the name of the next repository (based on the updated `i` counter) and update `found` accordingly

call json%get('['//count//'].name', value, found)

end do

! Traverse Repositories and Print Names

! Counter to traverse all repos one by one

i = 0

! Enter the loop to traverse all repositories while they exist

do

! Increment the counter for the next repository

i = i + 1

! Convert the updated counter to its string representation and store it in count variable

count = to_string(i)

! Fetch the name of the current repository (based on the `i` counter) and check if it exists

call json%get('['//count//'].name', value, found)

if(.not.found) exit

! If the repository name exists (`found` is true), print the repository number and name

print *, count//'. ', value

end do

Thanks, @jvdp1 now it's more readable

…epositories.

interkosmos · 2023-08-14T14:04:56Z

README.md

Examples of command-line input should probably start with a dollar sign to make it more obvious, i.e.,

$ sudo apt install -y libcurl4-openssl-dev

Instead of:

sudo apt install -y libcurl4-openssl-dev

I see your point, but one issue with that is that commands like this are likely to be copied to clipboard, which when pasted includes the "$" which breaks the command. So I think it's better to leave it out.

milancurcic · 2023-08-17T22:13:10Z

README.md

+    *~By [Rajkumar Dongre (rajkumardongre)](https://github.com/rajkumardongre)*
+* **[fortran-xkcd](https://github.com/rajkumardongre/fortran-xkcd/tree/http_client_version):** An fpm example project written in Fortran 2018 that displays the latest xkcd comic inside an X window. As a limitation, only images in PNG format are supported (no JPEG). The alt text will be printed to console.
+
+    *~By [Philipp (interkosmos)](https://github.com/interkosmos)*
+
+* **[foropenai](https://github.com/gha3mi/foropenai):** A Fortran library for OpenAI API.
+
+    *~By [AliG (gha3mi)](https://github.com/gha3mi)*


I think these "By author name" attributions are redundant, since you already link to the project GitHub repos, it's obvious who their authors are.

milancurcic · 2023-08-17T22:14:44Z

README.md

I see your point, but one issue with that is that commands like this are likely to be copied to clipboard, which when pasted includes the "$" which breaks the command. So I think it's better to leave it out.

milancurcic · 2023-08-17T22:17:16Z

README.md

+## Getting Started Guides 👋
+
+
+### Table of contents: 


Rather than having the tutorial TOC here, why not put it on top of tutorial.md? It seems more appropriate that a TOC for a doc would be in that doc, not outside of it. Here in the README you can just link to the tutorial doc.

milancurcic

Thank you for the great work, @rajkumardongre, I'll merge it.

Add Complete Tutorials

bd5550c

rajkumardongre requested review from interkosmos, milancurcic, jvdp1 and arteevraina August 10, 2023 19:21

rajkumardongre mentioned this pull request Aug 10, 2023

Added Tutorial for beginner(phase 1, only get request demonstration) #49

Closed

milancurcic reviewed Aug 11, 2023

View reviewed changes

jvdp1 reviewed Aug 12, 2023

View reviewed changes

rajkumardongre added 2 commits August 14, 2023 18:49

Rename the tutorial file and Update the loop to iterate through all r…

5edea2c

…epositories.

Update the version of fortran-curl

15bb3fe

interkosmos reviewed Aug 14, 2023

View reviewed changes

milancurcic reviewed Aug 17, 2023

View reviewed changes

rajkumardongre and others added 2 commits August 21, 2023 23:50

removed TOC from README.md

8786353

Clean up README

a8c948a

milancurcic approved these changes Aug 24, 2023

View reviewed changes

milancurcic merged commit e9f4926 into fortran-lang:main Aug 24, 2023

milancurcic mentioned this pull request Aug 24, 2023

Write a http-client tutorial #42

Closed

rajkumardongre deleted the issue42 branch September 14, 2023 19:38

	### Step 5: Import the Libraries
	### Step 4: Import the Libraries


		* `to_string` : We use this function to convert integers to their string representations

		### Step 6: Create the `print_org_repositories` Subroutine

	### Step 6: Create the `print_org_repositories` Subroutine
	### Step 5: Create the `print_org_repositories` Subroutine


		* [foropenai](https://github.com/gha3mi/foropenai): A Fortran library for OpenAI API.

		~By [AliG (gha3mi)](https://github.com/gha3mi)


		# Prerequisite 🚩

		Before building the GitHub Organization Analyzer library and running the program, you need to ensure that you have [`fpm`](https://fpm.fortran-lang.org/) (Fortran Package Manager) installed. Additionally, there is one dependency required for the [`http-client`](https://github.com/fortran-lang/http-client) library used in the project. Follow the steps below to set up your environment:


		### Step 2: Install libcurl Development Headers

		The `http-client` library, requires the libcurl development headers to be installed. On Ubuntu-based systems, you can install the required dependencies using the following command:

	The `http-client` library, requires the libcurl development headers to be installed. On Ubuntu-based systems, you can install the required dependencies using the following command:
	The `http-client` library requires the libcurl development headers to be installed. On Ubuntu-based systems, you can install the required dependencies using the following command:


		1. Open your terminal or command prompt and create a new directory for the project:

		```

Add Complete Tutorials #53

Add Complete Tutorials #53

Uh oh!

Conversation

rajkumardongre commented Aug 10, 2023

Uh oh!

milancurcic left a comment

Choose a reason for hiding this comment

Uh oh!

jvdp1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

milancurcic Aug 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

milancurcic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

milancurcic Aug 17, 2023 •

edited

Loading