Automatic generator of readmes for git repositories (Includes file' listing)

Overview

Readme Generator

We are bored of write the same things once and once again. We trust in the comments made inside of our files, and we decided to automate the boring stuff. Why to use this? Quick, Easy, Automatic: Only once three questions.

Description

The readmeg writes the basic structure of a readme file filling all the content and getting ready to show the awesome code that you do. It includes title, description, files, environment, and authors.

Installation

Move the file readmeg.py to the path /usr/local/bin. If you are in linux, you can use the next command:

$ cp readmeg.py readmeg && sudo mv readmeg /usr/local/bin

How to use

You need to go to the directory where you want to create the readme file. Then you can type this in the command line:

$ readmeg

or

$ readmeg The description of the reporitory

What readme's section are included?

Title

Takes the name of the directory, changing - and _ for spaces.

Description

It is a general description of the repository. readmeg ask the user what it is.

Files

It includes a spreadsheet with the names and descriptions of every file and function in the directory, specially man pages, C header files, C functions, and Python scripts. The name of the file can be clicked to open the file while you are looking the readme in git hub. The description of each file is based on the description of the file written in the first multiline comment of the file, looking like this:

File Description
file1 Description depending on the type of the file.

Python scripts

Takes the first multiline comment, surrounded by """ or by ''' as description.

C functions

Takes all the multiline comments of the file to list all the functions written in the file. The comments needs to match the format required by the ANSI 90 standard:

/**
* function_name - first line of description
* second line of description (optional)
* @parameter (optional)
* Return: returned value (optional)
*/

Let us know which other kind of programming files you want us to automate here: https://twitter.com/NaVeDuran1

Environment

The first time the program is executed is going to ask you the environ where the repository was developed. If you are from Holberton write: ''' Ubuntu 14.06.6 LTS '''

Authors

Readmeg reads the git configuration variables 'user.fullname', 'user.email' and 'user.environ'. If those aren't created, readmeg asks the full name of the user.

Changing Author, Email or Environment:

Type this commands to change the information that is going to be included in your subsequent readmes: ''' $ git config --config user.fullname My New Name ''' ''' $ git config --config user.email [email protected] ''' ''' $ git config --config user.environ my-environment ''' This will not change the readmes created previously.

Files

The files contained in this repository are:

File Description
README.md This are the instructions for use, non writtable for avoid mistakes.

Environment

This project has been tested on Ubuntu 14.06.6 LTS

Version

Released on April 29th of 2021.

  • Links of the files added on May 6th.

Authors

  • Nicolás Urrea Rangel: Email
  • Natalia Vera Duran: Email
  • Juan David Avila Caycedo: Email

Acknowledgment

By all your interest support, advice, and testing: Sergio Ramos, Alexander Forero, Jean Pierre and Holberton, our programming school, for making us to create a repo for day and then ask for readmes in each.

Owner
Natalia Vera Duran
Developer
Natalia Vera Duran
A tool written in python to generate basic repo files from github

A tool written in python to generate basic repo files from github

Riley 7 Dec 02, 2021
Backman is a random/fixed background image setter for wlroots based compositors

backman Backman is a random/fixed background image setter for wlroots based compositors Dependencies: The program depends on swaybg, python3-toml (or

Hemish 3 Mar 09, 2022
Python HTTP Agent Parser

Features Fast Detects OS and Browser. Does not aim to be a full featured agent parser Will not turn into django-httpagentparser ;) Usage import ht

Shekhar 213 Dec 06, 2022
isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections and by type.

isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections and by type. It provides a command line utility, Python library and plugins for various e

Python Code Quality Authority 5.5k Jan 08, 2023
Fcpy: A Python package for high performance, fast convergence and high precision numerical fractional calculus computing.

Fcpy: A Python package for high performance, fast convergence and high precision numerical fractional calculus computing.

SciFracX 1 Mar 23, 2022
Prime Path Generator is a prime path generator used to generate prime paths.

Prime Path Generator is a prime path generator used to generate prime paths.

1 Nov 06, 2021
New time-based UUID formats which are suited for use as a database key

uuid6 New time-based UUID formats which are suited for use as a database key. This module extends immutable UUID objects (the UUID class) with the fun

26 Dec 30, 2022
a tool for annotating table

table_annotate_tool a tool for annotating table motivated by wiki2bio,we create a tool to annoate all types of tables,this tool can annotate a table w

wisdom under lemon trees 4 Sep 23, 2021
A repo for working with and building daos

DAO Mix DAO Mix About How to DAO No Code Tools Getting Started Prerequisites Installation Usage On-Chain Governance Example Off-Chain governance Examp

Brownie Mixes 86 Dec 19, 2022
A python module for extract domains

A python module for extract domains

Fayas Noushad 4 Aug 10, 2022
Install, run, and update apps without root and only in your home directory

Qube Apps Install, run, and update apps in the private storage of a Qube. Build and install in Qubes Get the code: git clone https://github.com/micahf

Micah Lee 26 Dec 27, 2022
Stubmaker is an easy-to-use tool for generating python stubs.

Stubmaker is an easy-to-use tool for generating python stubs. Requirements Stubmaker is to be run under Python 3.7.4+ No side effects during

Toloka 24 Aug 28, 2022
Create password - Generate Random Password with Passphrase

Generate Random Password with Passphrase This is a python code to generate stron

1 Jan 18, 2022
Script to rename and resize folders of images

script to rename and resize folders of images

Tega Brain 2 Oct 29, 2021
This code renames subtitle file names to your video files names, so you don't need to rename them manually.

Rename Subtitle This code renames your subtitle file names to your video file names so you don't need to do it manually Note: It only works for series

Mostafa Kazemi 4 Sep 12, 2021
Simple tool for creating changelogs

Description Simple utility for quickly generating changelogs, assuming your commits are ordered as they should be. This tool will simply log all lates

2 Jan 05, 2022
VerSign: Easy Signature Verification in Python

VerSign: Easy Signature Verification in Python versign is a small Python package which can be used to perform verification of offline signatures. It a

Muhammad Saif Ullah Khan 3 Dec 01, 2022
Group imports from Windows binaries

importsort This is a tool that I use to group imports from Windows binaries. Sometimes, you have a gigantic folder full of executables, and you want t

【☆ ゆう ☆ 】 15 Aug 27, 2022
general-phylomoji: a phylogenetic tree of emoji

general-phylomoji: a phylogenetic tree of emoji

2 Dec 11, 2021
Standard implementations of FedLab and its provided benchmarks.

FedLab-benchmarks This repo contains standard implementations of FedLab and its provided benchmarks. Currently, following algorithms or benchrmarks ar

SMILELab-FL 104 Dec 05, 2022