Skip to content

README.md

Latest commit

 

History

History
59 lines (41 loc) · 2.71 KB

README.md

File metadata and controls

59 lines (41 loc) · 2.71 KB

CMI-DAIR Template Python Repository

This is a template repository. Below is a checklist of things you should do to use it:

  • Run setup_template.py to set up the repository.
  • Rewrite this README file.
  • Install the pre-commit hooks.
  • Update the LICENSE file to your desired license and set the year.
  • Update the supported versions in SECURITY.md or, if not relevant, delete this file.
  • Remove the placeholder src and test files, these are there merely to show how the CI works.
  • Grant third-party app permissions (e.g. Codecov) here, if necessary.
  • Either generate a CODECOV_TOKEN secret here (if its a private repository) or remove the line token: ${{ secrets.CODECOV_TOKEN }}
  • API docs website: After the first successful build, go to the Settings tab of your repository, scroll down to the GitHub Pages section, and select gh-pages as the source. This will generate a link to your API docs.
  • Update stability badge in README.md to reflect the current state of the project. A list of stability badges to copy can be found here. The node documentation can be used as a reference for the stability levels.

Project name

Build codecov Ruff stability-wip MIT License pages

What problem does this tool solve?

Features

  • A few
  • Cool
  • Things

Installation

Install this package via :

pip install linguamorph

Or get the newest development version via:

pip install git+https://github.com/cmi-dair/pkg-linguamorph

Quick start

Short tutorial, maybe with a

import linguamorph

linguamorph.short_example()

Links or References