DEV Community: Franklin Gonzi

Python 101: A beginner's guide.

Franklin Gonzi — Sun, 23 Jul 2023 10:35:40 +0000

Introduction.

The Python programming language’s popularity is surging in recent times. It is a general-purpose programming language used in a variety of applications ranging from data science to automation, software and web development, etc. An example of Python application is it’s use in creating recommendation algorithms, a form of machine learning. This article gives a succinct introduction to this very popular language.

An Overview.

Python is an object-oriented and high-level computer programming language used to build software, websites, automation tasks, and data analysis. There is no specific specialized field for Python hence it’s a general-purpose programming language. It was created by Guido Van Rossum and first released on February 20th 1991. He lavishly got this name from a BBC comedy series called Monty Python’s Flying circus.
Python has spread around the world fast due to the continuous work of programmers, testers, users and enthusiasts. One factor that may have attributed to this is its versatility and easy-to-use features, some of which are listed and described in this article, but first, why Python?

Why Python?

Python Institute describes it as omnipresent (Widely or constantly encountered) and people use numerous Python-powered devices on a daily basis. Its popularity in the tech world means one can work in a multitude of jobs and industries. There are several factors/features that make Python great for learning:

It is easy to learn – It takes a shorter time to learn Python compared to other programming languages. It has a simple syntax that uses English rather than punctuation. It is easy for writing new software due to faster coding.
It is open source and easy to obtain, install and deploy – Python is free, open and multiplatform.
It is extendable - Python code can be written in other languages such as C++ and users can low-level modules to the Python interpreter to customize and optimize tools.
It has a broad standard library that provides a rich set of modules and functions that are easily accessible by everyone.
It is portable – Python is a cross-platform programming language hence you can run the same code on any operating system with a Python interpreter.
It is an Object-Oriented language – It uses objects and classes in programming and hence implements real-world entities like inheritance, polymorphism, data abstraction, etc.
It has GUI programming support – Graphical user interfaces can be made using modules such as PyQt5.
It is a high-level language – When using Python, we do not need to remember system architecture or manage memory.
It allocates memory dynamically – The variable data type does not need to be specified; memory is allocated automatically at run time.

A beginner’s Python programming tutorial.

Installation and setup.

To get started working with Python, you need to have a Python interpreter (preferably the latest) installed on your computer through a series of easy steps which are available in the official website (www.python.org). There are different versions for different operating systems.
After installing the Python setup, you need to execute code and run programs. Python is used interactively by typing code directly into the interpreter, which is then executed or in a script file from the command line. Or you can use an IDE (Integrated Development Environment) such as PyCharm, Visual Studio Code, or Jupyter Notebook to interact with Python, these provide an editor with which you can create and modify code that is submitted to the interpreter for execution.

Libraries and Packages.

Python's strength lies in its extensive collection of libraries and packages. Libraries such as NumPy, Pandas, and Matplotlib provide powerful tools for data manipulation, analysis, and visualization. You can install and manage libraries using the package manager "pip" that comes with Python.

# Installing pandas library
! pip install pandas

# Importing installed libraries
import pandas as pd

Basic Syntax and Variables.

Python uses a simple and intuitive syntax. Statements are in simple English and blocks of code are defined by indentation. Python supports different types of variables, such as integers, floating-point numbers, strings, Booleans, and more.

# Printing a string
print ("Hello, World!")

Variables in Python do not require explicit type declarations, as they are dynamically typed. This means that a variable's type can change during runtime based on the value it holds.
Understanding the different data types is a prerequisite for data structures. There are several built-in data structures for organizing and storing data. The four commonly used ones are lists, sets, tuples, and dictionaries.

Lists - Lists are ordered collections of items enclosed in square brackets [ ]. They can contain elements of different data types (e.g., integers, strings, etc.). Lists are mutable, meaning you can modify, add, or remove elements.

my_list = [1, 2, "hello", 3.14]

Sets - Sets are unordered collections of unique items enclosed in curly braces { } or created using the set() constructor. They cannot contain duplicate values. Sets are useful for tasks like removing duplicates or checking membership. Sets are mutable, meaning you can add or remove elements.

my_set = {1,2,3,4,5}

Tuples - Tuples are ordered collections of items enclosed in parentheses () or without any delimiters. They can contain elements of different data types. Tuples are immutable, meaning you cannot modify their elements after creation. They are commonly used when you want to group related values together.

my_tuple = (1,2, "hello", 4)

Dictionaries - Dictionaries are unordered collections of key-value pairs enclosed in curly braces { } or created using the dict() constructor. They are also known as associative arrays or hash maps. Each element in a dictionary is a key-value pair, where the key is unique and used to access the corresponding value. Dictionaries are mutable, meaning you can modify, add, or remove key-value pairs.

my_dict = {
    "name":"John",
    "age":25,
    "city": "Nairobi"
}

These data structures serve different purposes and have various methods and operations associated with them. Understanding their characteristics and appropriate usage will help you effectively work with collections of data in Python.

Python Operators.

Operators are used to perform operations on variables and values. Python divides the operators in the following groups;

Arithmetic operators – These are used with numeric values to perform common mathematical operations.

They include;

addition (x + y).
subtraction (x – y).
multiplication (x * y).
division (x/y).
modulus (x%y).

Assignment operators – They are used to assign values to variables. The mostly used one is the = sign, e.g., x = 5. It can be used in combination with other signs to represent operations e.g., +=, x+= 3 is the same as x = x + 3

Comparison operators – These are used to compare values. Common ones include;

The Equal operator, ==, e.g., x==y
The Not Equal operator, !=, e.g., x!=y.
The Greater than operator, >, e.g., x>y.
The Less than operator, <, e.g., x<y.
The Greater than or Equal to operator, >=, e.g., x>=y.
The Less than or Equal to operator, <=, e.g., x<=y.

Logical operators – These are used to combine conditional statements.

and - Returns True if both statements are True.
or - Returns true if one of the statements is True.
not - Returns False if the result is True.

Identity operators – Used to compare objects not on an equal-to basis but on a same to or same memory location basis.

These are;

is - Returns True if both variables are the same object, e.g., x is y
is not - Returns True if both variables are not the same object, e.g., x is not y.

Membership operators – They are used to test if a sequence is presented in an object.

in - Returns True if a sequence with specified values are present in an object, e.g., x in y.
not in - Returns True if a sequence with specified values is not in an object, e.g., x not in y.

Control flow statements.

Python provides various control flow statements, such as conditional statements and loops, to control the execution of your program. Conditional statements, like if-else statements, allow you to execute different blocks of code based on certain conditions.

# if statement
x = 7
if x>0:
    print("Positive")
elif x<0:
    print("Negative")
else:
    print("zero")

# output:
Positive

# for loop
for i in range (3):
    print(i)

# output:
0
1
2

# while loop
count = 0
while count <3:
    print(count)
    count += 1

# output:
0
1
2

Functions and Modules.

Functions are reusable blocks of code that perform specific tasks. They allow you to break down complex programs into smaller, manageable parts. In Python, functions are defined using the "def" keyword.

# A function that returns a greeting and name
# Function definition
def greet(name):
    print ("Hi, "+name+"!")


#Function call
greet("Franklin")


Output:
Hi, Franklin!

Applications of Python.

Python is a versatile language and hence has a range of applications in different specialization fields. It is also evolving and opening up opportunities in new fields. A few common applications include;

Web Development - Python is widely used for web development, both on the server side and client-side. Popular frameworks like Django and Flask are built using Python, making it easier to create dynamic websites and web applications.
Data Analysis and Visualization- Python has become the de facto language for data analysis and manipulation due to its extensive libraries like NumPy, Pandas, and Matplotlib. These libraries provide powerful tools for data exploration, cleaning, analysis, and visualization.
Machine Learning and Artificial Intelligence - Python's simplicity and the availability of libraries such as TensorFlow, Keras, and Scikit-learn have made it the go-to language for machine learning and AI development. It offers extensive support for implementing and training machine learning models, as well as processing and analyzing large datasets.
Scripting and Automation - Python's easy-to-read syntax and cross-platform compatibility make it an excellent choice for scripting and automation tasks. It is often used to write scripts for automating repetitive tasks, system administration, and batch processing.
Game Development - Python can be used for game development, ranging from simple 2D games to more complex ones using libraries like Pygame and Panda3D. Python's ease of use and availability of libraries make it an accessible option for game developers.
Desktop GUI Applications - Python offers various frameworks like Tkinter, PyQt, and wxPython for creating graphical user interface (GUI) applications. These frameworks allow developers to build desktop applications with rich functionality and cross-platform compatibility.
Network Programming - Python provides libraries like socket, asyncio, and Twisted for network programming, making it easier to create networking applications, web servers, and networking tools.
Web Scraping - Python's libraries like Beautiful Soup and Scrapy make web scraping and data extraction tasks straightforward. It enables developers to extract data from websites and APIs for various purposes like data analysis, research, and automation.
Internet of Things (IoT) - Python is commonly used in IoT projects for its simplicity and compatibility with microcontrollers. Libraries like PySerial and Adafruit CircuitPython enable developers to interact with sensors, devices, and IoT platforms.

Disadvantages of Python.

While Python is a popular and widely used programming language, it does have some disadvantages that may be hard to ignore. Here are a few such disadvantages:

Performance - Python is an interpreted language, which means it tends to be slower than compiled languages like C or Java. This can be a significant disadvantage for computationally intensive tasks or applications that require real-time processing. While there are ways to optimize Python code, such as using libraries like NumPy or Cython, it may still fall short in terms of raw performance compared to lower-level languages.
Global Interpreter Lock (GIL) - Python has a Global Interpreter Lock, which is a mechanism that prevents multiple native threads from executing Python bytecodes at once. This can limit the ability to fully leverage multi-core processors for certain types of applications, particularly those with high levels of parallelism. While there are workarounds like using multiprocessing or threading libraries, they may introduce additional complexities.
Mobile and game development - Python is not considered the go-to language for mobile app development or game development, especially for performance-critical applications. Native app development for platforms like iOS or Android typically relies on languages like Swift, Objective-C, or Java/Kotlin. Similarly, game development often favors languages like C++ or C# due to their performance and existing game engines.
Limited mobile support - Although Python has frameworks like Kivy and BeeWare that allow for mobile app development, the support and ecosystem for mobile development in Python are not as mature as in languages like Swift or Java. This can lead to limitations in terms of available libraries, tools, and community support, making Python less attractive for mobile-focused projects.
Difficulty in code protection - Python's design philosophy emphasizes readability and simplicity, which can be beneficial for collaborative projects or learning. However, this can also make it challenging to protect Python source code from being easily reverse-engineered or tampered with. While there are tools available for code obfuscation or compilation into bytecode, they are not foolproof, and truly securing Python code can be more challenging compared to compiled languages.

Summary.

Over the past few years, Python has emerged as a top modern software due to its versatile application in modern software development, infrastructure management, and data analysis. Generally, it is an easy-to-use language and is broadly adopted and supported. However, it falls in some tasks that it is not suited for but these disadvantages are contextual and Python’s strength and range of application often outweighs them.

References.

Python Institute, Python® – the language of today and tomorrow, https://pythoninstitute.org/about-python#:~:text=Python%20was%20created%20by%20Guido,called%20Monty%20Python's%20Flying%20Circus.
By Simplilearn, last updated May 18th, 2023,14 Most Important Python Features and How to Use them, accessed June 27th, 2023, https://www.simplilearn.com/python-features-article
W3schools, Python Tutorial, accessed June 23rd 2023, https://www.w3schools.com/python/
PythonTM, Applications of Python, accessed June 27th, 2023 https://www.python.org/about/apps/
Jeff Novotny, Updated Thursday, March 9, 2023, The Pros and Cons of Python Programming, accessed June 27th, 2023, https://www.linode.com/docs/guides/pros-and-cons-of-python/

Technical writing 101: Technical Ultimate Guide.

Franklin Gonzi — Mon, 26 Jun 2023 18:36:20 +0000

Introduction.

Professionals in technical fields need to communicate information to regular consumers or users and team members of different expertise in a convenient and comprehensive way. Technical fields are industry subjects such as engineering, medical field, data science which use a language tailored towards the education level of its audience. Thus, technical communication is vital in businesses and industries to help outline concepts and procedures for task completion.

What is technical writing?

The Technical writing discipline is a form of technical communication that professionals use to convey information about specialized topics. In simple terms, a technical writer provides instructions or explains technical concepts regarding his/her area of expertise. This may be through instruction manuals, product specifications, job descriptions etc.

Components of technical writing.

Technical writing typically consists of several key components that help convey information effectively and facilitate understanding for the intended audience. The main components are;

Clear and concise language – Technical writing prioritizes clear and straight forward language to ensure that the information is easily understood. It avoids use of jargons, ambiguity, and acronyms to relay information in a concise manner.
Target Audience – Audience analysis is necessary in technical writing. Writers consider the readers background knowledge, technical expertise, and level of familiarity with the matter among other factors. The helps tailor the content to meet audience needs.
Document Structure - Technical documents follow a standardized structure to enhance readability and organization in term of titles, headings, subheadings, bullet points, tables, figures etc.
Visual aids – Technical writing frequently incorporates visual aids such as diagrams, charts, graphs, and illustrations which help present data and other complex concepts in a easy comprehensive way.
Formatting and styling – Proper formatting and styling enhance the readability and professionalism of technical documents. Specific fonts, margins, style guides like the MLA handbook, APA styles etc. and indentation enhance coherence.
Technical accuracy – Technical writing demands accuracy and precision. Writers must ensure that information provided is correct, up to date and is from credible sources. Definition of terms and measurements should be accurate and consistent throughout the document.
Revision and editing – Thorough revision and editing to spot grammatical errors, typos, inconsistencies and clarity issues are crucial to ensure a polished error free article ready for distribution.

Technical writing skills.

Technical writing requires a combination of relevant skills. These are abilities that help in preparing and publishing reports, manuals, guidelines, articles, and other forms of documentation effectively.

Writing skills - A technical writer needs writing skills to explain complex concepts clearly and concisely.
Editing skills – This is essential in proofreading. A technical writer must have a thorough understanding of grammar, spellings, style guides like the MLA handbook, APA styles etc and tone. Its also essential for reviewing facts, figures and statistics for accuracy.
Technical skills – A technical writer needs to be conversant with word processing software and documentation tools like Ms Word, LaTeX etc. to produce reports, articles and manuals.
Research skills – This involves gathering primary and secondary data from credible sources to ensure accuracy. It is necessary to become familiar with technical concepts and processes.
Communication skills – A technical writer needs to collaborate effectively in teams, ask questions and interview experts to gain information and gather feedback from users. Listening skills are also necessary to understand what people are saying.
Organization skills – Information needs to be organized effectively to determine the best way to structure your idea. Organization also implies time management techniques to prioritize tasks so as to meet deadlines.

Structure of a technical article.

A technical article typically follows a specific structure to effectively communicate information to its readers. However, the structure may vary slightly depending on the specific guidelines provided by the publication. Authors should always refer to those guidelines to ensure compliance with the required format and sections.

The general structure commonly used for technical articles;

Title - The article starts with a concise and informative title that accurately reflects the content of the article. The title should grab the reader's attention and give a clear idea of what the article is about.
Abstract - Following the title, an abstract provides a brief summary of the article's key points, objectives, and findings. It allows readers to quickly grasp the main ideas before deciding to read the entire article.
Introduction - The introduction sets the stage by providing background information about the topic and presenting the problem or research question that the article aims to address. It also explains the significance of the topic and highlights any existing gaps in knowledge or previous research.
Literature Review - In this section, the article discusses relevant studies, research papers, or existing literature related to the topic. The literature review provides context, establishes the current state of knowledge, and highlights any existing theories, models, or methodologies that have been used in the field.
Methodology or Experimental Setup - If the article involves research, this section explains the methodology or experimental setup employed to investigate the problem or answer the research question. It describes the research design, data collection methods, tools, equipment, and any statistical or analytical techniques used. Sufficient detail is provided to allow other researchers to replicate the study.
Results - In this section, the article presents the findings or results of the study. It may include tables, figures, charts, or graphs to present data and illustrate trends or patterns. The results are typically presented objectively and may be accompanied by a discussion or analysis of their significance.
Discussion - Here, the article interprets and analyzes the results, relating them back to the research question or problem stated in the introduction. It may discuss the implications, limitations, and potential applications of the findings. The discussion may also compare the results with previous studies or theories, highlighting similarities, differences, or any new insights gained.
Conclusion - The conclusion summarizes the main points discussed in the article, including the key findings and their implications. It restates the research question or problem and assesses whether the objectives of the article have been met. Additionally, it may suggest future research directions or areas that require further investigation.
References - A technical article includes a list of references or citations that acknowledge the sources used throughout the article. These references provide credibility, allow readers to explore the topic further, and demonstrate the author's familiarity with existing literature.
Acknowledgments - If applicable, the article may include a section where the authors acknowledge individuals, institutions, or funding sources that contributed to the research or article preparation.
Appendices - Supplementary material such as additional data, complex mathematical derivations, or detailed technical descriptions can be included in the appendices.

The writing process/steps.

Technical writing involves several stages to effectively communicate complex information in a comprehensive manner. The process can be iterative, with multiple rounds of revision and refinement. It includes the following steps;

Identifying the Purpose and Audience – A writer needs to have the purpose of the article and its recipient in mind. This will help in outlining the goals and objectives of the article, as well as the audience's level of technical expertise.
Conducting Research and Gathering necessary Information – The next stage entails gathering relevant information. This may involve both secondary and primary methods of data collection. A few examples include; studying technical specifications, conducting interviews with subject experts, reviewing existing documentation, or performing experiments or tests.
Planning and Organizing – This involves creating an outline for the article. The writer gets to determine the main sections, sub-sections, and their logical order to foster coherence.
Drafting – The writer needs an initial draft of the article. It is basically a summary of their ideas and information gathered on paper without too much grammar, punctuation, or style. It still needs to be in a clear, and concise manner.
Reviewing and Revising – The writer reviews his/her draft and revises it for clarity, accuracy, and completeness. This ensures that the content is well-organized, coherent, and easy to understand. Proof reading is essential to check grammatical errors, typos, and consistency in formatting. This step is iterative.
Incorporating Visual Aids - Identify opportunities to enhance understanding through visuals such as diagrams, charts, tables, or illustrations. Visuals can help clarify complex concepts and make the document more engaging and reader-friendly.
Formatting and Presentation – The article needs to be formatted appropriately using specified style guidelines like the APA or IEEE or templates. Headings, fonts, spacing, and page numbering should be consistent. The overall design presented should be visually appealing and easy to navigate.
User Testing - If the article is meant for a product or software being deployed, user testing is done to gather feedback. This step helps identify any areas that may need further clarification or improvement during maintenance and upgrading.
Finalizing and Publishing – The writer then makes the final revisions based on feedback and converts the article into the desired format, such as PDF, HTML, or a printed document. Publishing is done according to the intended distribution method, whether it's online, in print, or through a specific platform.

Application areas.

There are different forms of technical writing across various industries. It’s used in Developer documentation where technical communication is relayed in a layman's way to product users. It can be used in employee handbooks to relay information easily to new employees. It’s also applicable in medical research papers to provide great summaries of subject matters. User manuals of devices such as phones are also a form of technical communication. The list is endless!

References

Indeed Editorial Team, Updated March 11, 2023, What IS technical Writing? Definition, Examples and Steps, Accessed June 18, 2023 https://www.indeed.com/career-advice/careerdevelopment/technicalwriting#:~:text=Technical%20writing%20is%20a%20form,computer%20applications%20or%20medical%20procedures
Afoma Umesi, March 21, 2022, 7 best technical writing examples to improve your skills, Accessed June 18, 2023 https://gathercontent.com/blog/7-best-technical-writing-examples-to-improve-your-skills#:~:text=Technical%20writing%20is%20any%20writing,%2C%20finance%2C%20and%20consumer%20electronics