diff --git a/Jenkinsfile b/Jenkinsfile deleted file mode 100644 index 411aeb65..00000000 --- a/Jenkinsfile +++ /dev/null @@ -1,20 +0,0 @@ -pipeline { - agent any - options { - buildDiscarder(logRotator(numToKeepStr: '5')) - } - stages { - // Run the build in the against the dev branch to check for compile errors - stage('Add CLA label to PR') { - environment { - //spawns GITHUB_USR and GITHUB_PSW environment variables - GITHUB=credentials('38b2e4a6-167a-40b2-be6f-d69be42c8190') - } - steps { - // Using an install of Github repo CLA tagger - // (https://github.com/forslund/github-repo-cla) - sh '~/github-repo-cla/mycroft-core-cla-check.sh' - } - } - } -} diff --git a/readme.md b/readme.md index d97c316f..a3fc233b 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,33 @@ # Lingua Nostra -This is simply chatterbox's packaged version of https://github.com/MycroftAI/lingua-franca +Lingua_Nostra is chatterbox's natural language parser, it converts natural +language into data structures, and data structures into natural language! -Latest version: 0.4.1 +The main use case of lingua_nostra is handling dates and numbers -currently these repos are nearly identical, but will diverge over time \ No newline at end of file +Latest version: 0.4.3 + +## Supported Languages + +```TODO here will be a nice table comparing the state of language support ``` + +## Usage + +see the extensive unittests! + +```python +from lingua_nostra.format import nice_duration, nice_date, nice_date_time, \ + nice_number, nice_time, pronounce_number +from lingua_nostra.parse import extract_datetime, extract_number, \ + extract_numbers, extract_duration, normalize + +pronounce_number(100034000000299792458, short_scale=False) +#"one hundred trillion, thirty four thousand billion, " +#"two hundred and ninety nine million, seven hundred and ninety " +#"two thousand, four hundred and fifty eight" + + +extract_numbers("1 dog, seven pigs, macdonald had a farm, " + "3 times 5 macarena") +# [1, 7, 3, 5] +``` \ No newline at end of file diff --git a/setup.py b/setup.py index 6fc54a06..d36e799f 100644 --- a/setup.py +++ b/setup.py @@ -27,14 +27,16 @@ def required(requirements_file): setup( name='lingua_nostra', - version='0.4.2', + version='0.4.3', packages=['lingua_nostra', 'lingua_nostra.lang'], url='https://github.com/HelloChatterbox/lingua-nostra', license='Apache2.0', package_data={'': extra_files}, include_package_data=True, install_requires=required('requirements.txt'), - description='fork of Mycroftai lingua_franca 0.4.1', + description="Lingua_Nostra is chatterbox's natural language parser, " + "it converts natural language into data structures, and data " + "structures into natural language!", long_description=long_description, long_description_content_type="text/markdown", classifiers=[