DEV Community: techwriterjohn

Creating a virtual environment in Python

techwriterjohn — Sat, 29 Jul 2023 01:19:52 +0000

Quick version
This tutorial focuses on creating a virtual environment or venv for use with Python. I only intend to provide a brief introduction to venv, mostly providing the code necessary.

To install the venv software enter the following:

pip install virtualenv
Now you can create a venv on your system. To initiate venv within any directory type the following:

python<version> -m venv <virtual-environment-name>

Like so:

python3 -m venv myVenv

To activate the venv enter the following command:

source myVenv/bin/activate

If on Windows type this command instead:

.\myVenv\Scripts\activate

Now you're all ready to use your venv. Just install software and dependencies as you normally would.

When you are ready to stop using your venv just type the following:

deactivate

And that's it. You can now use a virtual environment in Python. For more on venv in Python view the documentation here.

SikuliX-WYSIWYG Automation

techwriterjohn — Sat, 29 Jul 2023 01:05:42 +0000

What is Sikuli?

Sikuli is an automation tool built in Java.

SikuliX can be used by software engineers, developers, test engineers, or anyone.
It allows you to automate anything on your screen on Windows, Mac, and some Linux operating systems.
Sikuli uses OpenCV, image recognition technology, to identify GUI components.
SikuliX comes with basic text recognition that can be used to search text in images. This feature is Tesseract.
SikuliX has an IDE, an integrated development environment, for easy WYSIWYG automation.
SikuliX also has the ability implement scripting via:
Python language level 2.7 (supported by Jython)
running RobotFramework text-scripts is supported (see docs)
Ruby language levels 1.9 and 2.0 (supported by JRuby)
JavaScript (supported by the Java Scripting Engine)

We will focus on using the IDE in this article.

Installation.

First, you’ll need to download the IDE, for your particular system, from Sikuli’s launch page:
Download SikuliX here.

If you do not have Oracle Java JDK (Java Development Kit) you will need to download and install it.

Download Oracle Java JDK here.

Similarly, you can use OpenJDK if your system requires it or is a preference.

Download OpenJDK here.

*You will need to download JDK or OpenJDK 8 or better.

To open SikuliX double-click on the jar

Or type in the following in the command prompt:

java -jar sikulix.jar -v

*If you find you cannot get this command to work, make sure you have the java jdk in your PATH.

Getting Started with SikuliX.
This is the SikuliX IDE:

Idea behind SikuliX is to have a simple script that uses image recognition.
As you can see on the IDE you have two main areas.

The main scripting area
The messages area which you can think of as a console.

Below the header you will see the follow buttons:
Take screenshot - takes a screenshot of a desired image of the screen
Insert Image - this button will insert a image you’ve already taken into your script
Region - This will take a shot of a region of the screen.
Location - This will allow you to click on the screen and get the precise location (X,Y).
Offset - This will allow you to get a new location which is dx and dy pixels away horizontally and vertically from the current location.

The SikuliX script commands are:
click(): The click command allows you to click on anything you see on your screen. Simply insert your image or screenshot with the click method ex. click(“image”).
type(): Use this command anytime you wish to type on the screen ex. type(“Hello World”). This is useful for textboxes and forms.
double-click(): Similar to the click command but clicks twice instead of once.
right-click(): Use this command to make use of right-click features of your mouse.

if(),elif(),else(): Use these commands if you need logic within your script. I will show an example later.

There are many other options and commands you can use. For our purposes, these 7 commands will suffice. For more, see the documentation here

Here is a simple SikuliX script:

This script uses only two commands and four lines of script. As you can see only two images were used for this demonstration.

First, with Google Chrome open, take a screenshot of the Google search bar area.

It will place the image in your script. You’ll need to type “click(image)” around it or simply type click() and then place the cursor between the parenthese, then take the screenshot. I prefer the second way.

We “click” in this area in order to make sure our cursor is there.

Next we type our search into the search bar using the “type()” command

type(“How to search Google”)

Next we use the “type()” command again to type enter.

type(Key.ENTER);

Finally we use the click() command, in the same manner ass before, on a web page found in our search.

In the end your script should look like this:

At this point, with your Google Chrome open, you can hit the run button.

The end result should be the following
Page:

Scripts can be as simple or complicated as you would like.

Use the if(), efif(), else commands when you need to use logic. An example would be checking to see if something exists on the screen:

I would encourage you to read the documentation for a complete list of command usage.

Enjoy automating!

Cursor - A.I. Powered Integrated Development Environment

techwriterjohn — Sat, 29 Jul 2023 00:43:27 +0000

I’d like to share some software that I ran across a couple months ago. It’s called Cursor. It is an IDE (integrated development environment) built for programming with A.I. I just happened upon an article on Cursor in the TDLR newsletter. So I decided to give it a shot.

You can use Cursor to write, edit, and chat about your code with GPT-3.5 or GPT-4. Cursor supports a wide range of programming languages, including but not limited to:
Python
JavaScript
Java
C++
C#
Ruby
Go
Rust
It is designed to be compatible with most popular programming languages.

The free tier of Cursor is powered by GPT-3.5. Paying users can use either GPT-3.5 or GPT-4. The free plan allows you to use the AI up to 100 times a month. If you need to use more, you will have to buy a pro plan.

What separates Cursor from Copilot? Cursor’s edit, chat, new AI project, and error fixing functionality is not available in Copilot. Cursor can write new code, similar to Copilot, but Cursor uses a much smarter AI.

Cursor is compatible with VSCode extensions. All you need to do is import them automatically with Cursor.

Cursor does not store any of your code on their servers. Currently they may store some code in the pursuit of AI analytics services, but you can always turn that off. Simply enable “Local Mode” in Settings.

Cursor gives the user the ability to ask about their codebase. If you join a development project and need help getting up to speed this feature is really useful.

Here is a quick example. I used example file example_code.c provided by Cursor at startup. I asked Cursor to explain the code and this was the result with the explanation is on the right hand side:

Cursor allows you to browse documentation from the chat.

You can edit existing code.

You have the ability to generate code from scratch. This feature is great if you want a starting point for a project.

Here’s an example of generating code from scratch. I ask Cursor to write me a program.

Here are the results:

Once you have code to work on Cursor can be used to spot and fix bugs.

Cursor also comes with a built in terminal for ease of use next to your code.

Cursor is a full featured IDE that is powered by A.I. I found that it introduced coding techniques I may not have otherwise thought up. As with any code help feature you will need to proof-read your code.

I have thoroughly enjoyed using Cursor thus far. It is available for Windows, Mac and Linux. Download it today from Cursor.

From code to content

techwriterjohn — Sat, 29 Jul 2023 00:35:39 +0000

A Former Software Engineer turned Technical Writer

Welcome to my corner of the web, where code and content converge in a harmonious symphony of communication. I, once immersed in the depths of software engineering, have embarked on an exciting transformation that led me to the captivating realm of technical writing.

Driven by a passion for clear and concise communication, I realized that my true calling lay beyond lines of code. Armed with my experience and expertise in software development, I decided to transition into the world of technical writing, embracing a new medium to express my knowledge and creativity.

Having traversed the intricate landscapes of programming languages and software frameworks, I bring a unique perspective to the art of technical writing. My extensive background in software engineering enables me to translate complex concepts into easily digestible and accessible content for readers of all technical backgrounds.

Through this website, I aim to share my invaluable insights, bridging the gap between technical jargon and clear understanding. From comprehensive software documentation to engaging tutorials and thought-provoking articles, I will weave my technical expertise with exceptional writing skills, creating content that empowers and enlightens.

Join me on a captivating journey as I continue to unravel the mysteries of the tech world, one eloquently crafted sentence at a time. Whether you're an aspiring developer, a curious reader, or a fellow technical writer, this space serves as a source of inspiration, knowledge, and camaraderie.

Together, let's explore the boundless possibilities that arise when a software engineer's knack for problem-solving merges with the artistry of the written word. Embark on this extraordinary adventure and discover how I plan on redefining the boundaries of communication in the ever-evolving landscape of technology.

Are you ready to dive into the enchanting fusion of software engineering and technical writing? Let the journey begin!"