# unihan-db

> SQLAlchemy models for the UNIHAN CJK character database. unihan-db provides the schema and ORM layer. For the ETL pipeline, see unihan-etl. For end-user character lookups, see cihai.

## Documentation

- [Quickstart](https://unihan-db.git-pull.com/quickstart/): Assure you have at least python >= 3.7.
- [API Reference](https://unihan-db.git-pull.com/api/): Data download, session helpers, and ETL options.
- [Project](https://unihan-db.git-pull.com/project/): Information for contributors and maintainers.
- [Changelog](https://unihan-db.git-pull.com/history/): To install the unreleased unihan-db version, see developmental releases.

## Documentation

- [Bootstrap - unihan_db.bootstrap](https://unihan-db.git-pull.com/api/bootstrap/): Fetch, extract, transform, and load UNIHAN into database.
- [Importing - unihan_db.importer](https://unihan-db.git-pull.com/api/importer/): Import functionality for UNIHAN DB.
- [Tables - unihan_db.tables](https://unihan-db.git-pull.com/api/tables/): unihan_db table schemas.
- [Code style](https://unihan-db.git-pull.com/project/code-style/): unihan-db uses ruff for linting and formatting.
- [Contributing](https://unihan-db.git-pull.com/project/contributing/): Install the package in editable mode with dev dependencies:
- [Releasing](https://unihan-db.git-pull.com/project/releasing/): unihan-db is pre-1.0. APIs may change between minor versions.