Skip to content

Commit

Permalink
docs: Update README files with additional project details and resources
Browse files Browse the repository at this point in the history 
- Enhanced descriptions and learning objectives for various projects.
- Added links to relevant resources and documentation.
- Improved formatting and structure for better readability.
  • Loading branch information
@hackerSa3edy
hackerSa3edy committed Oct 16, 2024
1 parent fe292b3 commit ca350b6
Show file tree
Hide file tree
Showing 23 changed files with 1,012 additions and 815 deletions.
73 changes: 38 additions & 35 deletions 0x00-python-hello_world/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,46 +1,49 @@
# Project: 0x00. Python - Hello, World

This directory contains introductory projects for learning Python programming. The tasks cover basic concepts such as running Python scripts, printing, string manipulation, and understanding Python's coding style.

## Resources

#### Read or watch:
### Read or watch

- [The Python tutorial](https://docs.python.org/3/tutorial/)
- [Whetting Your Appetite](https://docs.python.org/3/tutorial/appetite.html)
- [Using the Python Interpreter](https://docs.python.org/3/tutorial/interpreter.html)
- [An Informal Introduction to Python](https://docs.python.org/3/tutorial/introduction.html)
- [How To Use String Formatters in Python 3](https://realpython.com/python-string-formatting/)
- [Learn to Program](https://www.learnpython.org/)
- [Pycodestyle -- Style Guide for Python Code](https://pycodestyle.pycqa.org/en/latest/)

* [The Python tutorial](https://intranet.alxswe.com/rltoken/JsFCs_NBzMAR7-XPAZ9BoA)
* [Whetting Your Appetite](https://intranet.alxswe.com/rltoken/kifRlLG2iMX5AZiW8lrCMg)
* [Using the Python Interpreter](https://intranet.alxswe.com/rltoken/RVpfAuagCo9SdfYeoHd6jg)
* [An Informal Introduction to Python](https://intranet.alxswe.com/rltoken/bVps0ZPWq7qVZ7vc-eJGTw)
* [How To Use String Formatters in Python 3](https://intranet.alxswe.com/rltoken/Ju0J8BxkuPX5yKZctyKfsQ)
* [Learn to Program](https://intranet.alxswe.com/rltoken/szBsJ-Qyig_RrImN7RGlOg)
* [Pycodestyle -- Style Guide for Python Code](https://intranet.alxswe.com/rltoken/tgYt-0zVy1T4sDlE9ohxnA)
## Learning Objectives

### General

* Why Python programming is awesome
* Who created Python
* Who is Guido van Rossum
* Where does the name ‘Python’ come from
* What is the Zen of Python
* How to use the Python interpreter
* How to print text and variables using <code>print</code>
* How to use strings
* What are indexing and slicing in Python
* What is the official Python coding style and how to check your code with <code>pycodestyle</code>
## Tasks
- Why Python programming is awesome
- Who created Python
- Who is Guido van Rossum
- Where does the name ‘Python’ come from
- What is the Zen of Python
- How to use the Python interpreter
- How to print text and variables using `print`
- How to use strings
- What are indexing and slicing in Python
- What is the official Python coding style and how to check your code with `pycodestyle`

| Task | File |
| ---- | ---- |
| 0. Run Python file | [0-run](./0-run) |
| 1. Run inline | [1-run_inline](./1-run_inline) |
| 2. Hello, print | [2-print.py](./2-print.py) |
| 3. Print integer | [3-print_number.py](./3-print_number.py) |
| 4. Print float | [4-print_float.py](./4-print_float.py) |
| 5. Print string | [5-print_string.py](./5-print_string.py) |
| 6. Play with strings | [6-concat.py](./6-concat.py) |
| 7. Copy - Cut - Paste | [7-edges.py](./7-edges.py) |
| 8. Create a new sentence | [8-concat_edges.py](./8-concat_edges.py) |
| 9. Easter Egg | [9-easter_egg.py](./9-easter_egg.py) |
| 10. Linked list cycle | [10-check_cycle.c](./10-check_cycle.c), [lists.h](./lists.h) |
| 11. Hello, write | [100-write.py](./100-write.py) |
| 12. Compile | [101-compile](./101-compile) |
| 13. ByteCode -> Python #1 | [102-magic_calculation.py](./102-magic_calculation.py) |
## Tasks

| Task | File | Description |
| ------------------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| 0. Run Python file | [0-run](./0-run) | Write a Shell script that runs a Python script. |
| 1. Run inline | [1-run_inline](./1-run_inline) | Write a Shell script that runs Python code. |
| 2. Hello, print | [2-print.py](./2-print.py) | Write a Python script that prints exactly "Programming is like building a multilingual puzzle". |
| 3. Print integer | [3-print_number.py](./3-print_number.py) | Complete this source code in order to print the integer stored in the variable number. |
| 4. Print float | [4-print_float.py](./4-print_float.py) | Complete the source code in order to print the float stored in the variable number with a precision of 2 digits. |
| 5. Print string | [5-print_string.py](./5-print_string.py) | Complete this source code in order to print 3 times a string stored in the variable str, followed by its first 9 characters. |
| 6. Play with strings | [6-concat.py](./6-concat.py) | Complete this source code to print Welcome to Holberton School! |
| 7. Copy - Cut - Paste | [7-edges.py](./7-edges.py) | Complete this source code |
| 8. Create a new sentence | [8-concat_edges.py](./8-concat_edges.py) | Complete this source code to print object-oriented programming with Python. |
| 9. Easter Egg | [9-easter_egg.py](./9-easter_egg.py) | Write a Python script that prints “The Zen of Python”, by Tim Peters. |
| 10. Linked list cycle | [10-check_cycle.c](./10-check_cycle.c), [lists.h](./lists.h) | Write a function in C that checks if a singly linked list has a cycle in it. |
| 11. Hello, write | [100-write.py](./100-write.py) | Write a Python script that prints a message to stderr. |
| 12. Compile | [101-compile](./101-compile) | Write a script that compiles a Python script file. |
| 13. ByteCode -> Python #1 | [102-magic_calculation.py](./102-magic_calculation.py) | Write the Python function def magic_calculation(a, b): that does exactly the same as a given Python bytecode. |
89 changes: 46 additions & 43 deletions 0x01-python-if_else_loops_functions/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,54 +1,57 @@
# Project: 0x01. Python - if/else, loops, functions

This directory contains projects focused on understanding and implementing control flow tools in Python. The tasks cover concepts such as if/else statements, loops, functions, and handling various Python-specific features.

## Resources

#### Read or watch:
### Read or watch

- [More Control Flow Tools](https://docs.python.org/3/tutorial/controlflow.html)
- [IndentationError](https://realpython.com/invalid-syntax-python/#indentationerror)
- [How To Use String Formatters in Python 3](https://realpython.com/python-string-formatting/)
- [Learn to Program](https://www.learnpython.org/)
- [Learn to Program 2 : Looping](https://www.learnpython.org/en/Loops)
- [Pycodestyle -- Style Guide for Python Code](https://pycodestyle.pycqa.org/en/latest/)

* [More Control Flow Tools](https://intranet.alxswe.com/rltoken/jpjs5EnZTpBLLEremJYjPQ)
* [IndentationError](https://intranet.alxswe.com/rltoken/F9n2AE-fpEPzt2PfBMGYAQ)
* [How To Use String Formatters in Python 3](https://intranet.alxswe.com/rltoken/ZdtRIAkFu8dMBT99DcFBNg)
* [Learn to Program](https://intranet.alxswe.com/rltoken/ElQgZYNHrLI7kV_ysEB1hQ)
* [Learn to Program 2 : Looping](https://intranet.alxswe.com/rltoken/ElQgZYNHrLI7kV_ysEB1hQ)
* [Pycodestyle -- Style Guide for Python Code](https://intranet.alxswe.com/rltoken/TuTTnEg_Rwn8U1g3PEsZmA)
## Learning Objectives

### General

* Why Python programming is awesome
* Why indentation is so important in Python
* How to use the <code>if</code>, <code>if ... else</code> statements
* How to use comments
* How to affect values to variables
* How to use the <code>while</code> and <code>for</code> loops
* How is Python’s <code>for</code> different from <code>C</code>‘s?
* How to use the <code>break</code> and <code>continues</code> statements
* How to use <code>else</code> clauses on loops
* What does the <code>pass</code> statement do, and when to use it
* How to use <code>range</code>
* What is a function and how do you use functions
* What does return a function that does not use any <code>return</code> statement
* Scope of variables
* What’s a traceback
* What are the arithmetic operators and how to use them
## Tasks
- Why Python programming is awesome
- Why indentation is so important in Python
- How to use the `if`, `if ... else` statements
- How to use comments
- How to assign values to variables
- How to use the `while` and `for` loops
- How is Python’s `for` different from `C`‘s?
- How to use the `break` and `continue` statements
- How to use `else` clauses on loops
- What does the `pass` statement do, and when to use it
- How to use `range`
- What is a function and how do you use functions
- What does return a function that does not use any `return` statement
- Scope of variables
- What’s a traceback
- What are the arithmetic operators and how to use them

| Task | File |
| ---- | ---- |
| 0. Positive anything is better than negative nothing | [0-positive_or_negative.py](./0-positive_or_negative.py) |
| 1. The last digit | [1-last_digit.py](./1-last_digit.py) |
| 2. I sometimes suffer from insomnia. And when I can't fall asleep, I play what I call the alphabet game | [2-print_alphabet.py](./2-print_alphabet.py) |
| 3. When I was having that alphabet soup, I never thought that it would pay off | [3-print_alphabt.py](./3-print_alphabt.py) |
| 4. Hexadecimal printing | [4-print_hexa.py](./4-print_hexa.py) |
| 5. 00...99 | [5-print_comb2.py](./5-print_comb2.py) |
| 6. Inventing is a combination of brains and materials. The more brains you use, the less material you need | [6-print_comb3.py](./6-print_comb3.py) |
| 7. islower | [7-islower.py](./7-islower.py) |
| 8. To uppercase | [8-uppercase.py](./8-uppercase.py) |
| 9. There are only 3 colors, 10 digits, and 7 notes; it's what we do with them that's important | [9-print_last_digit.py](./9-print_last_digit.py) |
| 10. a + b | [10-add.py](./10-add.py) |
| 11. a ^ b | [11-pow.py](./11-pow.py) |
| 12. Fizz Buzz | [12-fizzbuzz.py](./12-fizzbuzz.py) |
| 13. Insert in sorted linked list | [13-insert_number.c](./13-insert_number.c), [lists.h](./lists.h) |
| 14. Smile in the mirror | [100-print_tebahpla.py](./100-print_tebahpla.py) |
| 15. Remove at position | [101-remove_char_at.py](./101-remove_char_at.py) |
| 16. ByteCode -> Python #2 | [102-magic_calculation.py](./102-magic_calculation.py) |
## Tasks

| Task | File | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 0. Positive anything is better than negative nothing | [0-positive_or_negative.py](./0-positive_or_negative.py) | Write a script that assigns a random signed number to the variable `number` each time it is executed and prints whether the number is positive, negative, or zero. |
| 1. The last digit | [1-last_digit.py](./1-last_digit.py) | Write a script that assigns a random signed number to the variable `number` each time it is executed and prints the last digit of the number. |
| 2. I sometimes suffer from insomnia. And when I can't fall asleep, I play what I call the alphabet game | [2-print_alphabet.py](./2-print_alphabet.py) | Write a program that prints the ASCII alphabet, in lowercase, not followed by a new line. |
| 3. When I was having that alphabet soup, I never thought that it would pay off | [3-print_alphabt.py](./3-print_alphabt.py) | Write a program that prints the ASCII alphabet, in lowercase, except `q` and `e`, not followed by a new line. |
| 4. Hexadecimal printing | [4-print_hexa.py](./4-print_hexa.py) | Write a program that prints all numbers from 0 to 98 in decimal and in hexadecimal. |
| 5. 00...99 | [5-print_comb2.py](./5-print_comb2.py) | Write a program that prints numbers from 0 to 99. |
| 6. Inventing is a combination of brains and materials. The more brains you use, the less material you need | [6-print_comb3.py](./6-print_comb3.py) | Write a program that prints all possible different combinations of two digits. |
| 7. islower | [7-islower.py](./7-islower.py) | Write a function that checks for lowercase character. |
| 8. To uppercase | [8-uppercase.py](./8-uppercase.py) | Write a function that prints a string in uppercase followed by a new line. |
| 9. There are only 3 colors, 10 digits, and 7 notes; it's what we do with them that's important | [9-print_last_digit.py](./9-print_last_digit.py) | Write a function that prints the last digit of a number. |
| 10. a + b | [10-add.py](./10-add.py) | Write a function that adds two integers and returns the result. |
| 11. a ^ b | [11-pow.py](./11-pow.py) | Write a function that computes `a` to the power of `b` and returns the value. |
| 12. Fizz Buzz | [12-fizzbuzz.py](./12-fizzbuzz.py) | Write a function that prints the numbers from 1 to 100 separated by a space. |
| 13. Insert in sorted linked list | [13-insert_number.c](./13-insert_number.c), [lists.h](./lists.h) | Write a function in C that inserts a number into a sorted singly linked list. |
| 14. Smile in the mirror | [100-print_tebahpla.py](./100-print_tebahpla.py) | Write a program that prints the ASCII alphabet, in reverse order, alternating lowercase and uppercase (z in lowercase and A in uppercase), not followed by a new line. |
| 15. Remove at position | [101-remove_char_at.py](./101-remove_char_at.py) | Write a function that creates a copy of the string, removing the character at the position `n` (not the Python way, the “C array index”). |
| 16. ByteCode -> Python #2 | [102-magic_calculation.py](./102-magic_calculation.py) | Write the Python function `def magic_calculation(a, b, c):` that does exactly the same as the following Python bytecode: |
Loading

0 comments on commit ca350b6

Please sign in to comment.