Skip to content

Latest commit

 

History

History
45 lines (24 loc) · 877 Bytes

README_DEV.md

File metadata and controls

45 lines (24 loc) · 877 Bytes

Notes for Developers

These are notes to remind me how to do things on this project.

Installation

mdinfo uses poetry for dependency management.

Install poetry:

`pip install poetry`

To install the dependencies, run:

`poetry install`

Building

mdinfo uses doit for building.

To build the project, run:

`doit`

Testing

mdinfo uses pytest for testing. The test suite can be run with the following command:

`poetry run pytest`

or

`doit test`

Versioning

Use bump2version to update the version number.

`poetry run bump2version [major|minor|patch] [--verbose] [--dry-run]`

README update

The README.md is updated automatically using cogapp. The README.md will be updated when running doit.