Course Index 
Make the index of your course in a window or in the terminal, compile it to PDF.
Course Index is a desktop application (with a terminal version) for editing the .idx file of the LaTeX Course Index Template, the condensed two-column indexes made for courses with several books (e.g. SANS courses, see the examples).
Instead of editing \indexentry{...} lines by hand, type the term, the book and the page: the template's conventions (|book{N}, a new line for each additional book, sort keys, sections, ...) are applied for you, the index is checked while you type, and F5 compiles the PDF.
$ pip install course-index
$ course-index sec504.idx
The same editor runs in the terminal with --tui (and starts there by itself when no graphical session is available):
Features
- Quick-add bar: book, page, term, Enter. The book and page stay for the next term;
Ctrl+↑/Ctrl+↓turn the page. - Sections as collapsible blocks of lines; new entries go straight to the block of their book.
- Validated input: the book must exist (
F3creates one), the page cannot be 0 and a range must end after it starts. - Sections and books (Sections tab,
F4): rename, add, delete and move the sections, set or change the book of a section and renumber its entries, rename the title of a book (the bold title of its parts in the Topics). - Suggestions of the existing terms while typing (
Tabcompletes), so that the pages of a term land on the same line of the index. - Template conventions applied automatically: book number on the first page of a term in a book, a
term!line for each additional book, sort keys for terms starting with a command (\texttt{.htaccess}→Htaccess@...), new entries placed next to their group (Topics/Categories) or in their book's section. - Shortcuts:
`nc`→\texttt{nc},**x**→\textbf{x},:linux:→\linux,_ & % #escaped. - Structured editor of an entry (levels, sort keys, book, pages, icons, rating) synchronized with its raw
\indexentryline. - Preview of the index as it will be typeset, checks (missing book, duplicates, book number not on the first page, unknown commands, malformed lines), filter (
book:2 page:45 netcat). - Blank lines, page breaks and cross-references in one key, undo/redo, comment out (
%), move lines. - Lossless: comments, sections and formatting of the file are kept; unchanged lines are written back as they were.
- PDF compilation with
makeindexandpdflatex(F5), with the bundled template when the index is not in a template folder.
Usage
$ course-index # edit ./main.idx (created if missing)
$ course-index sec504.idx --tui # edit it in the terminal instead of a window
$ course-index --init mycourse/ # copy the template (main.tex, data.tex, lib/) and start a new index
$ course-index sec504.idx --pdf # compile sec504.pdf without opening the editor
$ course-index sec504.idx --check # list the problems of the index
| Key | Action |
|---|---|
a |
add references (quick-add bar) |
Enter / e, n |
edit the entry, new entry |
d, c, Space |
delete, duplicate, comment out |
b, p, x |
blank line, page break, cross-reference |
→ / ←, + / - |
expand / collapse the section, all the sections |
/ |
filter |
Ctrl+S, F5 |
save, compile the PDF |
F2 |
course metadata (code, title, date, version, author), shown in the sidebar |
F3 |
new book |
F4 |
Sections tab (sections and their books) |
Ctrl+Z / Ctrl+Y |
undo / redo |
F1 |
help |
Compiling requires a TeX distribution providing makeindex and pdflatex, with the packages used by the template (e.g. texlive-latex-extra on Debian/Ubuntu).
Credits
The bundled LaTeX template comes from the LaTeX Course Index Template (CC BY 4.0).
Metadata
Release files for course-index 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| course_index-0.1.0.tar.gz | 1.9 MB | With provenance | Details for course_index-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| course_index-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for course_index-0.1.0-py3-none-any.whl |
Total release size: 2.0 MB
Release files / course_index-0.1.0.tar.gz
| Download URL | course_index-0.1.0.tar.gz |
|---|---|
| Size | 1.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b9b5d42869724167357ef431ea2a5a23d8aaa3185c7154f6dfb44292ec128da9
|
|
BLAKE2b-256 checksum How to use checksums |
d267a1e73686e302743cbcc7a1028a8b803781ae721b7058772ca6b3f80c468c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.
Transparency logRelease files / course_index-0.1.0-py3-none-any.whl
| Download URL | course_index-0.1.0-py3-none-any.whl |
|---|---|
| Size | 171.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2cdd45aec9a5d2e0b507e41ae09383b4b53048b194a4421540e5e179cae70b56
|
|
BLAKE2b-256 checksum How to use checksums |
a7a99784b26d60fdaf8379f63fcf2401c4c0ff9d6a341d5680d538cc2f899274
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.
Transparency logSecurity for course-index 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for course_index-0.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.