Home

This is the beets wiki. It's home to developer documentation and semi-coherent notes about the beets project. If you're looking for help using beets, take a look at the beets documentation or the FAQ.

These wiki pages may be relevant to users:

• FAQ: Answers all your questions about beets (things we get asked a lot in the #beets IRC channel on Freenode).
• PathFormatCookbook: Some interesting and useful path format strings.
• Hacking: How to get involved with the beets project (even if you're not a programmer!). Also, how to live on the cutting edge by running beets from source.
• Concepts: A high-level description of the theory of beets and its internals.
• Cookbook: A collection of recipes for using beets to do amazing things.

These pages are more of interest to developers:

• MediaFile: The (reusable) infrastructure included with beets for reading and writing the tags on music files.
• Testing: Notes on the test cases.
• Optimization: If we ever get to a point where performance is a higher priority than functionality, this page lists some possible optimization opportunities.
• Refactoring: Some plans for small- to medium-sized refactorings that beets might need.
• ReleaseChecklist: How to make a new release of beets.
• Architecture: Evolving notes about the project's software architecture.
• Python3: Notes on porting beets to Python 3.x.

Finally, these pages are mainly compendia of notes that may be helpful someday.

• MacOSX: Some Mac-centric quirks.
• Packaging: Notes on packaging for different operating systems.
• PriorArt: Notes on other projects that we can learn from
• Wishlist: Ideas for future versions of beets.
• Scratchpad: Miscellaneous notes.