kamilib-light

A light version of KaMI-lib containing only the transcription metrics module (without Kraken).

https://github.com/kami-tools-project/kami-lib-light

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

A light version of KaMI-lib containing only the transcription metrics module (without Kraken).

Basic Info
  • Host: GitHub
  • Owner: KaMI-tools-project
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 55.2 MB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Created almost 4 years ago · Last pushed almost 4 years ago
Metadata Files
Readme License Citation

README.md

KaMI-lib (Kraken Model Inspector) - Light version

Python Version

KaMI-lib light CI Version License: MIT

A light version of KaMI-lib containing only the transcription metrics module (without Kraken).

:electric_plug: Installation

User installation

Use pip to install package:

bash $ pip install kamilib-light

Developer installation

  1. Create a local branch of the kami-lib light project

bash $ git clone https://github.com/KaMI-tools-project/KaMI-lib-light.git

  1. Create a virtual environment

bash $ virtualenv -p python3.7 venv

then

bash $ source kami_venv/bin/activate

  1. Install dependencies with the requirements file

bash $ pip install -r requirements.txt

  1. Run the tests

bash $ python -m unittest tests/*.py -v

:key: Quickstart

Please, follow the documentation of kami-lib and ignore part 2 (with Kraken engine).

Note that instead of importing Kami-lib like this:

python from kami.Kami import Kami

Replace by this:

python from kami_light.Kami import Kami

:question: Do you have questions, bug report, features request or feedback?

Please use the issue templates:

:beetle: Bug report: here

:fireworks: Features request: here

if aforementioned cases does not apply, feel free to open an issue.

:black_nib: How to cite

@misc{Kami-lib-light, author = "Lucas Terriel (Inria - ALMAnaCH) and Alix Chagu (Inria - ALMAnaCH)", title = {Kami-lib - Kraken model inspector, a light version}, howpublished = {\url{https://github.com/KaMI-tools-project/KaMI-lib-light}}, year = {2022} }

:octopus: License and contact

Distributed under MIT license. The dependencies used in the project are also distributed under compatible license.

Mail authors and contact: Alix Chagu (alix.chague@inria.fr) and Lucas Terriel (lucas.terriel@inria.fr)

KaMI-lib-light is a part of KaMI-tools-project and developed and maintained by authors (2022) with contributions of ALMAnaCH at Inria Paris.

forthebadge made-with-python

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 6
  • Total Committers: 2
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.167
Top Committers
Name Email Commits
Lucas Terriel 4****e@u****m 5
Lucaterre l****l@g****m 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 20 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 2
  • Total maintainers: 1
pypi.org: kamilib-light

A light version of KaMI-lib Python package containing only the transcription metrics module (without Kraken).

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 20 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 21.6%
Forks count: 29.8%
Average: 34.5%
Stargazers count: 38.8%
Downloads: 72.1%
Maintainers (1)
Last synced: 12 months ago

Dependencies

requirements.txt pypi
  • protobuf ==3.20.0
  • python-Levenshtein ==0.12.2
  • termcolor ==1.1.0
  • unidecode ==1.3.4
requirements_dev.txt pypi
  • protobuf ==3.20.0 development
  • pylint ==2.14.5 development
  • pytest ==7.1.2 development
  • python-Levenshtein ==0.12.2 development
  • termcolor ==1.1.0 development
  • unidecode ==1.3.4 development
setup.py pypi
  • protobuf ==3.20.0
  • python-Levenshtein ==0.12.2
  • termcolor ==1.1.0
  • unidecode ==1.3.4