para

TITLE

How to use, create, and distribute Raku modules


SUBTITLE

head

A module is usually a source file or set of source files that expose Raku
constructs N<Technically a module is a set of I<compunits> which are usually
files but could come from anywhere as long as there is a I<compunit repository>
that can provide it. See L<S11|https://github.com/Raku/old-design-docs/blob/master/S11-modules.pod>.>.


Modules are typically packages (L<classes|/language/objects#Classes>,
L<roles|/language/objects#Roles>, L<grammars|/type/Grammar>),
L<subroutines|/language/functions>, and sometimes
L<variables|/language/variables>. In Raku I<module> can also refer to a type of
package declared with the C<module> keyword (see L<Module
Packages|/language/module-packages> and the examples below) but here we mostly
mean "module" as a set of source files in a namespace.


See L<Using Modules: An Introduction|/language/using-modules/introduction>


See L<Using Modules: Finding and Installing|/language/using-modules/finding-installing>


See L<Using Modules|/language/using-modules/code>


See L<Making Modules|/language/making-modules/introduction>


How to organize your module with regard to its usage


See L<Making Modules|/language/making-modules/code>


See L<Distributions: An Introduction|/language/distributions/introduction>.


See L<Distributions: The Configuration and Structure|/language/distributions/configuration-structure>


See L<Distributions: The Tools|/language/distributions/tools>


See L<Distributions: Testing|/language/distributions/testing>.


See L<Distributions: Uploading|/language/distributions/uploading>.


See L<Distributions: An Introduction|/language/distributions/introduction#Contact_information>


root

Introspection and the Raku object system


Metaobject protocol (MOP)


What can help you write/test/improve your module(s)


Module development utilities


A tutorial about creating and using classes in Raku


Classes and objects


How and when Raku modules are compiled, where they are stored, and how to access them in compiled form.


CompUnits and where to find them


Concurrency and asynchronous programming


Concurrency


Creating your own CLI in Raku


Command line interface


An introduction to grammars


Grammar tutorial


File-related operations


Input/Output


Programs running other programs and communicating with them


Inter-process communication


Functionalities available for visiting all items in a complex data structure


Iterating


Different mathematical paradigms and how they are implemented in this language


Doing math with Raku


Creating module packages for code reuse


Module packages


Core modules that may be useful to module authors


Core modules


A short tutorial on how to declare operators and create new ones.


Creating operators


Some tips on regexes and grammars


Regexes: best practices and gotchas


Interactive Raku, read-eval-print loop


REPL


Slangs in Raku


Slangs


Input methods for unicode characters in terminals, the shell, and editors


Entering unicode characters


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


Built with L<Podlite|https://podlite.org> — the markup and publishing tools behind this site.


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Modules

Creating and using modules

Using Modules

Introduction

Looking for and installing modules

Loading and using modules

Making Modules

Terminology and basic structure

How to organize your module with regard to its usage

Distributing modules

Preparing the module

Tools that help with module authoring

Testing modules and a distribution

Uploading the module

Discussing module development

See Also