README.md

Nordjylland News

Dataset containing news from Northern Jutland in Denmark.

---

Developers:

• Oliver Kinch ([email protected])
• Dan Saattrup Nielsen ([email protected])

Setup

Set up the environment

1. Run make install, which installs Poetry (if it isn't already installed), sets up a virtual environment and all Python dependencies therein.
2. Run source .venv/bin/activate to activate the virtual environment.

Install new packages

To install new PyPI packages, run:

$ poetry add <package-name>

Get an overview of the available commands

Simply write make to display a list of the commands available. This includes the above-mentioned make install command, as well as building and viewing documentation, publishing the code as a package and more.

Tools used in this project

• Poetry: Dependency management
• hydra: Manage configuration files
• pre-commit plugins: Automate code reviewing formatting
• pdoc: Automatically create an API documentation for your project

Project structure

.
├── .flake8
├── .github
│   └── workflows
│       ├── ci.yaml
│       └── docs.yaml
├── .gitignore
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── config
│   ├── __init__.py
│   └── config.yaml
├── data
├── makefile
├── models
├── notebooks
├── poetry.toml
├── pyproject.toml
├── src
│   ├── scripts
│   │   ├── fix_dot_env_file.py
│   │   └── versioning.py
│   └── nordjylland_news
│       └── __init__.py
└── tests
    └── __init__.py