Skip to main content

README.md

1# chives
3chives is a collection of Python functions for working with my local
4media archives.
6I store a lot of media archives as [static websites][static-sites], and I use Python scripts to manage the sites.
7This includes:
9* Verifying every file that's described in the metadata is stored correctly
10* Downloading pages from sites I want to bookmark
11* Checking the quality and consistency of my metadata
13This package has some functions I share across multiple archives/sites.
15[static-sites]: https://alexwlchan.net/2024/static-websites/
17## References
19I've written blog posts about some of the code in this repo:
21* [Cleaning up messy dates in JSON](https://alexwlchan.net/2025/messy-dates-in-json/)
22* [Detecting AV1-encoded videos with Python](https://alexwlchan.net/2025/detecting-av1-videos/)
24## Versioning
26This library is monotically versioned.
27I'll try not to break anything between releases, but I make no guarantees of back-compatibility.
29I'm making this public because it's convenient for me, and you might find useful code here, but be aware this may not be entirely stable.
31## Usage
33See the docstrings on individual functions for usage descriptions.
35## Installation
37If you want to use this in your project, I recommend copying the relevant function and test into your codebase (with a link back to this repo).
39Alternatively, you can install the package from PyPI:
41```console
42$ pip install alexwlchan-chives

Development

If you want to make changes to the library, there are instructions in CONTRIBUTING.md.

License

MIT.