DEV Community: jadorotan

readMeMaker: v0.1

jadorotan — Sat, 21 Sep 2024 01:44:40 +0000

About This Tool

ReadMeMaker is a CLI tool that will help users write their README.MD documentation depending on the input files the user specifies.

How to Start Using ReadMeMaker?

Clone the Repository

git clone https://github.com/jadorotan/readMeMaker

Install the Required Dependencies for the tool to work

pip install -r requirements.txt

Create a .env file and put inside your Groq API Key (https://console.groq.com)

GROQ_API_KEY=YOUR API KEY HERE

Basic CLI Usage

This tool is still in it's early stages and doesn't have much any complex commands. One such example of a simple command you can run is this:

python readMeMaker.py -i .\examples\simpleCalculator.py -o .\examples\generated.md

The command above will take the input file simpleCalculator.py that's inside the examples directory and using the -o option will store the generated.md file inside the same directory as the calculator python file. A demo of several other commands can also be found in this video: Youtube Demo.

Other CLI OPTIONS

Option	Shortcut	Description	Default
-v	--version	Show the version of the tool.	-
-h	--help	Show this help message and exit	-
-i	--input	The input files for which to generate a README.md.	-
-o	--output	Specify the output file name and file path.	Creates a README.md file in the same directory
-m	--model	Specify the model to use for generating the README.md.	Uses llama3-8b-8192

GitHub Repository

If you are interested in using this tool or even trying to contribute and improve the tool further, you can find it at: readMeMaker.

Conclusion

ReadMeMaker is still in its early stages of development but even so, this tool with its simple options can aid its users with writing their README.MD documentation for their code and possibly streamlining the process and saving time for the users who aren't well-versed in writing their own markdown files. This tool was made by utilizing Groq's AI Chat Completions Prompts.

The Start to my Open Source Development Journey

jadorotan — Sat, 07 Sep 2024 00:44:18 +0000

About Me

Hi! My name is Jerus Allen and I'm currently studying Computer Programming and Analysis (CPA) at Seneca College. I'm currently in my fifth semester of the CPA program and this blog will contain my steps and struggles in my journey of becoming a more proficient developer by contributing to various Open Source Projects and working with people from the community.

So, Why Become Part of the Open Source Community?

To be honest, I didn't have any expectations or idea of what Open Source Development is. However, after the first introduction lecture and learning that this course is structured to give the students as much freedom as possible really interested me. Being able to work together with many people with each person having different levels of expertise and being able to help and give feedback to each other's work is something I value a lot and want to be a part of.

My Goals with Open Source Development

To keep it short, I just want to experience as many coding niches/languages as I can to broaden my perspective as a developer and discover what I really want to pursue and specialize in after my studies at Seneca. This will also give me real-world practical experience and feedback from people who have been programming for a long time and are a part of the Open Source Community which will (hopefully) help my skills and understanding of programming and help me break into the Tech Workplace.

A GitHub Trending Repo That Caught My Interest

In my journey of trying to expand to different programming niches/languages and my love for listening to music as I do whatever task I'm currently doing, I discovered a trending repository called: Spotube which is an Open Source, Cross-Platform Client for both Spotify and YouTube that removes the need to subscribe to Spotify/YouTube Premium to listen to music without the interruption of ads and allows for downloading music for offline listening.