Dakoda Core

A Python library for DAKODA corpus management.

DAKODA is an interdisciplinary project with the overarching goal of advancing the data competencies of early-career researchers in German as a Foreign/Second Language (DaF/DaZ) in the field of learner corpus research. The project develops language technology resources for acquisition-related research questions and tests them based on a broad data foundation.

Prerequisites

• Python 3.9+ (3.11+ recommended via pyenv)
• Poetry for dependency management (see installation guide)

Setup

1. Clone the repository

   git clone git@github.com:dakoda-project/dakoda-core.git
   cd dakoda-core
   

2. Install dependencies and create virtual environment

   poetry install
   

3. Verify installation

   poetry run python -c "from dakoda import *; print('Dakoda Core installed successfully!')"
   

Development

Project Structure

dakoda-core/
├── src/
│   └── dakoda/           
│       ├── corpus.py     
│       ├── countries.py  
│       ├── languages.py  
│       ├── dakoda_types.py          
│       ├── dakoda_metadata_scheme.py 
│       ├── util.py      
│       └── res/          
│           ├── dakoda-logo.png
│           └── dakoda_typesystem.xml
├── tests/                
└── data/                 

Running Tests

# Run all tests
poetry run pytest

# Run with coverage
poetry run pytest --cov=dakoda

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests: poetry run pytest
5. Submit a pull request

Release (PyPI)

Short release checklist:

1. Update the version in pyproject.toml.

2. Run tests:

   poetry run pytest
   

3. Build distribution artifacts:

   poetry build
   

4. Publish:

   export POETRY_PYPI_TOKEN_PYPI="pypi-XXXXXXXXXXXXXXXXXXXX"
   poetry publish
   

Notes:

• Use API tokens for authentication (__token__ username).
• Create a fresh build (poetry build) for every release.

License

This project is licensed under the Apache License 2.0. See LICENSE.