README
¶
Go Helper Library For Kids
This repository contains code that aims to make learning Go programming considerably less painful for children and other beginners. It contains a number of convenience functions and other features that come built-in with simpler languages like Python, and hopefully eases the Golang learning curve a little 🙂.
Go is a wonderful, modern cross-platform language for teaching, is almost as easy to pick up as Python or Ruby, and the elegant simplicity of the syntax makes it a joy to work with. Go is an excellent choice for anyone wishing to gain a better understanding of statically-typed, compiled languages. This repository is currently a work in progress and a companion to my (unfinished) programming book for kids.
Getting started and Installation
To import this library, simply type the following into the terminal:
go get git.paleblue.cloud/mark/go4kids
To use it in your code, add the following to the top of your Go file(s), and use it like so:
package main
import (
"fmt"
g4k "git.paleblue.cloud/mark/go4kids"
)
func main() {
greeting := "Hello everyone! I am learning Go!"
fmt.Println(g4k.ReverseString(greeting))
}
!oG gninrael ma I !enoyreve olleH
Support
For help, support or suggestions, feel free to shoot me an email at mark@paleblue.cloud. This is a personal project, but I'm open to suggestions for improvement :)
Roadmap
-
Implement basic functions to help the youngsters begin their Go journey.
-
Implement some more complex functions and other data structures to avoid re-inventing the wheel.
-
TODO
Contributing
This is a personal project that is probably of little interest to anyone yet, but suggestions for improvement are always welcome.
Licenses
All source code is released under The MIT License, and any other original materials are licensed under the Creative Commons BY-NC 4.0. Other resources contained in this document and any web-pages and/or information linked to remain the intellectual property of the original authors. Information copied or adapted from these sources is used under the terms of their respective licences, and I have attempted to adhere to the principles of acceptable use where any ambiguity exists.
I have given full credit to all original authors wherever possible, and encourage the reader to browse the original sources of any or all of the information included. These source materials contain a wealth of fascinating in-depth information, explained far better than I could ever hope to achieve.
Disclaimer
I take full responsibility for any inaccuracies, misunderstandings, misinterpretations, omissions, and plain old stupidity contained within my code or the book. I take great delight in writing about the fascinating world of technology, but sadly the world always finds ways to make an idiot of me. If anything seems wrong, correct me via email, and check the great sources in the next section.
Resources
Websites
-
Official Go Documentation, the Standard Library reference, and the Go FAQ.
-
The Go Blog also has some wonderfully in-depth articles on Go's inner workings. For example, this article on the internal magic of slices and arrays, this one on how strings and runes work underneath, or this one on how maps work internally. It may sound boring, but is vital knowledge if you want to be a better programmer.
-
DevDocs (Much like the Standard Library reference above, but much faster and easier to read. It's not just Go either, it has everything)
-
Go By Example (Excellent resource for when you just want answers now)
-
Go Web Examples (Very good web-focused tutorials)
-
Awesome Go (A curated list of Go frameworks, libraries, and software)
-
Golang Weekly (Weekly Go newsletter sent to your email)
-
Awesome Go Weekly (Another weekly Go newsletter)
Free (or free-ish) Books
Note: Although some free Go books are a little older, Go has a conservative approach to language changes and is committed to backwards-compatibility. Aside from updates to best-practices, little has changed in the past decade, and 99% of the principles are still valid.
-
Go 101, and its GitHub repository: Excellent and up-to-date book that can even be installed and read offline with
go install go101.org/go101@latest, thengo101to start the web server. -
Go, From the Beginning (Up-to-date, very thorough)
-
Practical Go Lessons (Up-to-date, free web version)
-
How to Code in Go (Fantastic tutorial series by DigitalOcean. Web, PDF or EPUB, but web is best)
-
The Web-Dev-Golang-Anti-Textbook, and its GitHub repository. Excellent book about Go web development.
Free Videos
-
Learn Go Programming - Golang Tutorial for Beginners (freeCodeCamp, 7 hours)
-
Learn Go Programming by Building 11 Projects – Full Course (freeCodeCamp, 8.5 hours)
-
Golang Tutorial for Beginners | Full Go Course (YouTube, ~3.5 hours)
-
Golang Dojo (YouTube channel)
-
Golang Tutorial : Go Full Course (Derek Banas, ~3.5 Hours)
-
Go / Golang Crash Course (Traversy Media, ~1.5 hours)
Recommended Udemy Videos (Paid)
Tools
-
Go Playground (Run Go in the browser and try out code)
-
Better Go Playground (As above, but much nicer)
-
JSON-To-Go (Converts JSON to Go structs automatically, also available as a VS Code extension. You'll thank me later 😏)
Documentation
¶
Index ¶
- func All[T any](s []T, f func(T) bool) bool
- func Any[T any](s []T, f func(T) bool) bool
- func Contains[T comparable](s []T, item T) bool
- func ContainsAny[T comparable](s []T, items ...T) bool
- func Deduplicate[T comparable](s []T) []T
- func Filter[T any](s []T, f func(T) bool) []T
- func Input(prompt string) string
- func IsDir(path string) bool
- func IsExecutable(path string) bool
- func IsFile(path string) bool
- func IsOwner(path string) bool
- func IsReadable(path string) bool
- func IsSymlink(path string) bool
- func IsWritable(path string) bool
- func Map[T, U any](s []T, f func(T) U) []U
- func Max[T Number](s []T) T
- func Min[T Number](s []T) T
- func Normalise(s string) string
- func PathExists(path string) bool
- func PrintBlue(s string)
- func PrintBold(s string)
- func PrintClear()
- func PrintClearLine()
- func PrintCyan(s string)
- func PrintGreen(s string)
- func PrintMagenta(s string)
- func PrintRed(s string)
- func PrintReset()
- func PrintUnderline(s string)
- func PrintWhite(s string)
- func PrintYellow(s string)
- func RandomChoice[T any](s []T) T
- func RandomInt(min, max int) int
- func RandomRange(min, max, length int) []int
- func RandomSequence(min, max, length int) chan int
- func RemoveIndex[T any](s []T, i int) []T
- func RemoveItems[T comparable](s []T, item T, max int) []T
- func ReverseSlice[T any](s []T) []T
- func ReverseString(s string) string
- func Shuffle[T any](slice []T)
- func SumSlice[T Number](s []T) T
- type Number
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func All ¶
All is a function that checks if all items in a slice satisfy a given condition and returns true or false accordingly.
func Any ¶
Any is a function that checks if any of the items in a slice satisfy a given condition and returns true or false accordingly.
func Contains ¶
func Contains[T comparable](s []T, item T) bool
Contains is a function that checks if a slice contains a given item and returns a boolean.
func ContainsAny ¶
func ContainsAny[T comparable](s []T, items ...T) bool
ContainsAny is a function that checks if a slice contains any of a given set of items and returns a boolean.
func Deduplicate ¶
func Deduplicate[T comparable](s []T) []T
Deduplicate removes duplicate elements from a slice and returns the result.
func Filter ¶
Filter is a function that filters a slice by a given condition and returns the resulting slice.
func IsExecutable ¶
IsExecutable is a function that returns true if the path exists and is executable.
func IsFile ¶
IsFile is a function that returns true if the path exists and is a regular file, i.e. not a directory, symlink, block device, etc.
func IsOwner ¶
IsOwner is a function that returns true if the path exists and is owned by the current user.
func IsReadable ¶
IsReadable is a function that returns true if the path exists and is readable.
func IsWritable ¶
IsWritable is a function that returns true if the path exists and is writable.
func Normalise ¶
Normalise is a function that returns a lowercase version of a string with leading and trailing whitespace removed.
func PathExists ¶
PathExists is a function that returns true if the path exists, whether it is a file, directory, symlink, or anything else.
func PrintClearLine ¶
func PrintClearLine()
PrintClearLine is a function that clears the current line.
func PrintMagenta ¶
func PrintMagenta(s string)
PrintMagenta is a function that prints a string in magenta.
func PrintReset ¶
func PrintReset()
PrintReset is a function that resets the terminal to its default state.
func PrintUnderline ¶
func PrintUnderline(s string)
PrintUnderline is a function that prints a string in underline.
func PrintYellow ¶
func PrintYellow(s string)
PrintYellow is a function that prints a string in yellow.
func RandomChoice ¶
func RandomChoice[T any](s []T) T
RandomChoice is a function that returns a random element from a slice.
func RandomInt ¶
RandomInt is a function that returns a random integer between min and max. To generate a large number of random integers, use RandomSequence instead.
func RandomRange ¶
RandomRange is a function that returns a slice of random integers between min and max.
func RandomSequence ¶
RandomSequence is a function that returns a channel of random integers between min and max. This method is more efficient than RandomRange, and can be used to generate an arbitrarily large number of random integers.
func RemoveIndex ¶
RemoveIndex is a function that removes an item by index from a slice and returns the resulting slice.
func RemoveItems ¶
func RemoveItems[T comparable](s []T, item T, max int) []T
RemoveItems is a function that removes items by value from a slice, up to a "max" times, and returns the resulting slice. If max is 0, all items are removed.
func ReverseString ¶
ReverseString is a function that reverses a string and returns the result.
Types ¶
type Number ¶
type Number interface {
constraints.Integer | constraints.Float | constraints.Signed | constraints.Unsigned
}
Number is an interface that represents any number type.
Source Files