The Hy Manual

PyPI

https://pypi.python.org/pypi/hy

Source

https://github.com/hylang/hy

Discussions

https://github.com/hylang/hy/discussions

Stack Overflow

The [hy] tag

Hy is a Lisp dialect that’s embedded in Python. Since Hy transforms its Lisp code into Python abstract syntax tree (AST) objects, you have the whole beautiful world of Python at your fingertips, in Lisp form.

To install the latest release of Hy, just use the command pip3 install --user hy. Then you can start an interactive read-eval-print loop (REPL) with the command hy, or run a Hy program with hy myprogram.hy.

• Why Hy?
  • Hy versus Python
  • Hy versus other Lisps
• Tutorial
  • Lisp-stick on a Python
  • Literals
  • Basic operations
  • Functions, classes, and modules
  • Macros
  • Hyrule
  • Next steps
• Syntax
  • An introduction to models
    • Object
    • Lazy
  • Non-form syntactic elements
    • Shebang
    • Whitespace
    • Comments
    • Discard prefix
  • Identifiers
    • Numeric literals
    • Keywords
    • Symbols
    • Mangling
  • String literals
    • String
    • Bytes
    • Bracket strings
  • Sequential forms
    • Sequence
    • Expressions
    • List, tuple, and set literals
    • Dictionary literals
    • Format strings
  • Additional sugar
  • Reader macros
• Semantics
  • Implicit names
  • Order of evaluation
  • When bytecode is regenerated
• Macros
  • Using gensym for Safer Macros
• The Hy REPL
  • HyREPL
    • HyREPL.run()
  • Output functions
  • Special variables
  • Startup files
• Environment Variables
• Command Line Interface
  • hy
    • Command Line Options
  • hy2py
  • hyc
• Hy <-> Python interop
  • Using Python from Hy
  • Using Hy from Python
    • Compiled files
    • Launching a Hy REPL from Python
    • Evaluating strings of Hy code from Python
  • Libraries that expect Python
• Model Patterns
  • A motivating example
  • Usage
• Cheatsheet
  • Hy
  • Core
• API
  • Core Macros
    • #^
    • annotate()
    • .
    • fn()
    • fn/a()
    • defn()
    • defn/a()
    • defmacro()
    • if()
    • await()
    • break()
    • chainc()
    • continue()
    • do()
    • for()
    • assert()
    • global()
    • get()
    • import()
    • eval-and-compile()
    • eval-when-compile()
    • lfor()
    • dfor()
    • gfor()
    • sfor()
    • setv()
    • setx()
    • let()
    • match()
    • defclass()
    • del()
    • nonlocal()
    • py()
    • pys()
    • quasiquote()
    • quote()
    • require()
    • return()
    • cut()
    • raise()
    • try()
    • unpack-iterable()
    • unpack-mapping()
    • unquote()
    • unquote-splice()
    • while()
    • with()
    • with/a()
    • yield()
    • yield-from()
    • cond
    • defreader
    • delmacro
    • doc
    • export
    • when
    • Placeholder macros
  • Hy
    • read()
    • read-many()
    • eval()
    • repr()
    • repr-register()
    • mangle()
    • unmangle()
    • disassemble()
    • macroexpand()
    • macroexpand-1()
    • gensym()
    • as-model()
    • hy.errors.COLORED
  • Reader Macros
    • HyReader
    • Reader
  • Python Operators
    • !=()
    • %()
    • &()
    • *()
    • **()
    • +()
    • -()
    • /()
    • //()
    • <()
    • <<()
    • <=()
    • =()
    • >()
    • >=()
    • >>()
    • @()
    • [x y]()
    • and()
    • comp-op()
    • get()
    • in()
    • is()
    • not-in()
    • not?()
    • or()
    • reduce()
    • |()
    • ~()
  • Reserved
    • macros()
    • names()
• Hacking on Hy
  • Join our Hyve!
  • Hack!
  • Test!
  • Document!
  • Contributor Guidelines
    • Issues
    • Pull requests
  • Contributor Code of Conduct
  • Core Team