From ed7c9eca80a2b9990c9272cb3a4760f968bd71f6 Mon Sep 17 00:00:00 2001 From: JJ Asghar Date: Tue, 16 Apr 2024 12:56:35 -0500 Subject: [PATCH] Add spellcheck workflow Co-authored-by: Christian Kadner Signed-off-by: JJ Asghar Signed-off-by: BJ Hargrave --- .github/dependabot.yml | 4 + .github/workflows/spellcheck.yml | 45 ++++++ .gitignore | 7 +- .spellcheck-en-custom.txt | 230 +++++++++++++++++++++++++++++ .spellcheck.yml | 28 ++++ .travis.yml | 23 --- CONTRIBUTING.md | 2 +- Collaboration.md | 2 +- InstructLabSlackGuide.md | 4 +- InstructLabSlackModerationGuide.md | 2 +- Makefile | 4 + README.md | 6 +- docs/DataSources.md | 22 +-- requirements.txt | 3 + tox.ini | 16 ++ 15 files changed, 355 insertions(+), 43 deletions(-) create mode 100644 .github/workflows/spellcheck.yml create mode 100644 .spellcheck-en-custom.txt create mode 100644 .spellcheck.yml delete mode 100644 .travis.yml create mode 100644 requirements.txt create mode 100644 tox.ini diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 861bbc5..11e5f50 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -11,6 +11,10 @@ updates: interval: "daily" # Maintain dependencies for Python scripts + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "daily" - package-ecosystem: "pip" directory: "/tools/maintainers" schedule: diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..7067940 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,45 @@ +# SPDX-License-Identifier: Apache-2.0 + +name: Spellcheck + +on: + push: + branches: + - "main" + paths: + - '**.md' + - '.github/workflows/spellcheck.yml' # This workflow + pull_request: + branches: + - "main" + paths: + - '**.md' + - '.github/workflows/spellcheck.yml' # This workflow + +env: + LC_ALL: en_US.UTF-8 + +defaults: + run: + shell: bash + +permissions: + contents: read + +jobs: + spellcheck: + name: Spellcheck (en_US) + runs-on: ubuntu-latest + steps: + - name: "Harden Runner" + uses: step-security/harden-runner@a4aa98b93cab29d9b1101a6143fb8bce00e2eac4 # v2.7.1 + with: + egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs + + - name: "Checkout" + uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 + with: + fetch-depth: 0 + + - name: Spellcheck + uses: rojopolis/spellcheck-github-actions@dbd2f1da869c05ad874fffeb6fe1ed50cd1a6e98 # v0.36.0 diff --git a/.gitignore b/.gitignore index 5ceb386..88294ca 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,6 @@ -venv +venv/ +.venv/ +.tox/ +dictionary.dic +.vscode/ +.idea/ diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt new file mode 100644 index 0000000..8fbf7c5 --- /dev/null +++ b/.spellcheck-en-custom.txt @@ -0,0 +1,230 @@ +# make spellcheck-sort +# Please keep this file sorted: +# SPDX-License-Identifier: Apache-2.0 +Aakanksha +aakankshaduggal +abhi +Abramson +Acknowledgements +Adminstrators +akashgit +al +alimaredia +Alina +alinaryan +Anh +anik +Anza +Approver +Approvers +AQuA +Arapahoe +ARB +arge +Asghar +Ashgar +backend +Bernardino +bjhargrave +Boelkins +Byars +Bzostek +caradelia +CDLA +cdoern +CHANGELOG +Chatbot +Choi +ckadner +CLI +CNCF +coc +CoCC's +codebase +codebases +Conala +Corbett +curation +cybette +darrellreimer +dave +DCO +De +deployable +DeSaix +dev +DM +Doern +Duggal +Eder +Eggebrecht +et +Fraknoi +Freeform +freeform +Frontend +frontend +Gair +gcc +Greenlaw +GSM +Haver +Helpsteer +HH +hickeyma +Hidaka +Hinrichs +Huben +ibm +ics +ilab +Illowsky +inglis +InstructLab +integrations +Jaideep +jaideepr +JamesKunstle +Janssen +jeremyeder +JJ +jjasghar +joesepi +Jolla +Jonick +judgement +juliadenham +Keene +kelbrown +khaledsulayman +Kordas +Korol +Kruse +Kubernetes +Kunstle +LGTM +LGTMs +lhawthorn +lignment +LLM +LLM's +Lovett +luke +Lund +Lyryx +Mahbobi +Maintainership +maintainership +mairin +Máirín +Maredia +markstur +Marymount +Masaki +McElaney +md +Merlinite +mingxzhao +Miniforge +Mixtral +mmcelaney +MMLU +Moebs +mrutkows +mscherer +Multivariable +Musique +nathan +nerdalert +Neth +NOIRLab +noone +Norwood +NumGLUE +OASST +obuzek +ODC +oindrillac +Oksana +Oleg +openbookQA +Oswego +ots +Pfannestiel +PII +Prahl +pre +Precalculus +PRM +pyenv +PyPI +pypi +qa +Quinnipiac +Rao +README +Rebecca +Redbooks +redbooks +Repo +repo +resynthesizes +RHLF +Roadmap +Roush +russellb +Saftey +Sandhills +Sanny +Schlicker +Schneegurt +Seminario +Sepi +SETI +sexualized +shivchander +signoff +signoffs +Silkin +socio +soltysh +SPDX +Spelman +Spielman +spzala +Stanberry +Standup +Sudalairaj +supermajority +Tatlock +templated +Theopold +Thi +Tiemann +TODO +Triager +triagers +Triaging +UI +Urone +USC +Usings +Ventura +venv +Vickery +vishnoianil +Volker +Vretta +Wakefield +Waskiewicz +weinberg +Wikimedia +wikimultihop +wordmarks +workstreams +xukai +YAML +yhwang +Zach +Zedalis +Zimmitti diff --git a/.spellcheck.yml b/.spellcheck.yml new file mode 100644 index 0000000..2795088 --- /dev/null +++ b/.spellcheck.yml @@ -0,0 +1,28 @@ +# SPDX-License-Identifier: Apache-2.0 + +matrix: +- name: markdown + aspell: + lang: en + d: en_US + camel-case: true + mode: markdown + sources: + - "**/*.md|!.tox/**" + dictionary: + wordlists: + - .spellcheck-en-custom.txt + pipeline: + - pyspelling.filters.context: + context_visible_first: true + escapes: '\\[\\`~]' + delimiters: + # Ignore multiline content between fences (fences can have 3 or more back ticks) + # ```language + # content + # ``` + - open: '(?s)^(?P *`{3,}).*?$' + close: '^(?P=open)$' + # Ignore text between inline back ticks + - open: '(?P`+)' + close: '(?P=open)' diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 782216d..0000000 --- a/.travis.yml +++ /dev/null @@ -1,23 +0,0 @@ -language: ruby - -before_install: - - echo "#" - - echo "#" - - echo "TravisCI is unbelively powerful, but you need to do your research first." - - echo "#" - - echo "#" - -script: - - echo "#" - - echo "#" - - echo "Please take a look https://docs.travis-ci.com/user/tutorial/ for you options." - - echo "#" - - echo "#" - - -after_success: - - echo "#" - - echo "#" - - echo "Don't forget to enable it in the GitHub repository also.." - - echo "#" - - echo "#" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c1f8d7..3714dfa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,7 +72,7 @@ For a list of the maintainers and triagers, see the [MAINTAINERS.md](MAINTAINERS To propose a new feature, it's best to raise an issue in the appropriate repository: -* [Instructlab CLI repository](https://github.com/instructlab/instructlab/issues) +* [InstructLab CLI repository](https://github.com/instructlab/instructlab/issues) * [Taxonomy repository](https://github.com/instructlab/taxonomy/issues) This way, features can be discussed with the project maintainers, ensuring that your time is not wasted working on a feature that the project developers will not accept into the codebase. diff --git a/Collaboration.md b/Collaboration.md index 7e63105..c32ac54 100644 --- a/Collaboration.md +++ b/Collaboration.md @@ -74,7 +74,7 @@ users | anyone | anyone | members | noone ## [GitHub Discussions](#github-discussions) -We are using the GitHub discussion boards in each repo for cases where we need to document things quickly but emphemerally, such as working together as a community to squash a nasty bug. In that case, a link to the appropriate discussion board post will be sent to the relevant project mailing lists so folks can follow along on GitHub. Rather than use the discussion boards to discuss proposals for enhancements or to request help with using InstructLab, please reach out on the project [email lists](#email-lists) or [Slack](#chat). +We are using the GitHub discussion boards in each repo for cases where we need to document things quickly but ephemerally, such as working together as a community to squash a nasty bug. In that case, a link to the appropriate discussion board post will be sent to the relevant project mailing lists so folks can follow along on GitHub. Rather than use the discussion boards to discuss proposals for enhancements or to request help with using InstructLab, please reach out on the project [email lists](#email-lists) or [Slack](#chat). ## [Hugging Face](#hugging-face) diff --git a/InstructLabSlackGuide.md b/InstructLabSlackGuide.md index b770a4d..ddd3a40 100644 --- a/InstructLabSlackGuide.md +++ b/InstructLabSlackGuide.md @@ -15,7 +15,7 @@ All discussions in the InstructLab Slack are governed by our [project code of co - `#dev` Cross-project coordination discussion, such as topics that cover both frontend and backend development for InstructLab - `#admin` Place to get non-technical help. If you don't know where to go after reading this guide, join this channel for [air traffic control](https://en.wikipedia.org/wiki/Air_traffic_control). -- `#announce` Project wide announcements such as releases, reminders about community calls, and celebrating new maintainers. This channel is moderated (only [Workspace Adminstrators](https://github.com/instructlab/community/blob/main/InstructLabSlackModerationGuide.md#workspace-administrators) can post) and low-traffic. +- `#announce` Project wide announcements such as releases, reminders about community calls, and celebrating new maintainers. This channel is moderated (only [Workspace Administrators](https://github.com/instructlab/community/blob/main/InstructLabSlackModerationGuide.md#workspace-administrators) can post) and low-traffic. - `#backend` Backend work for the InstructLab project, including pipeline for synthetic data generation, training, model evaluation, and publishing. - `#community` Place to discuss community matters such as improving the contributor experience, getting help reviewing a presentation about InstructLab you want to give at a meetup, or learning how you can contribute to InstructLab beyond software development. - `#contribhelp` General questions about getting started as an InstructLab contributor. This channel is the place to go if you need help with your first pull request. @@ -48,5 +48,5 @@ TODO: Update with email address to get help once these are set up. InstructLab is an open source project and we value defaulting to open in all of our community communications. There are some cases where discussions must happen in private. For the sake of transparency, we are documenting these private channels and what they are used for. -- `#code-of-conduct-committee` Space for the InstructLab [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/COCC.md) to discuss any reports of harassement or other violations of the project Code of Conduct and how to respond to them. +- `#code-of-conduct-committee` Space for the InstructLab [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/COCC.md) to discuss any reports of harassment or other violations of the project Code of Conduct and how to respond to them. - `#mods` Space for the InstructLab [Workspace Administrators](https://github.com/instructlab/community/blob/main/InstructLabSlackModerationGuide.md#workspace-administrators) to confer privately only when necessary. We default to open and hold each other accountable to do so. diff --git a/InstructLabSlackModerationGuide.md b/InstructLabSlackModerationGuide.md index 0177802..cca4309 100644 --- a/InstructLabSlackModerationGuide.md +++ b/InstructLabSlackModerationGuide.md @@ -15,7 +15,7 @@ Moderation activities can only be performed by users who are designated as works ## Workspace Administrators -At time of writing, our workspace adminstrators/moderators are as follows: +At time of writing, our workspace administrators/moderators are as follows: * Aakanksha Duggal * Ali Maredia diff --git a/Makefile b/Makefile index c33811f..33d684f 100644 --- a/Makefile +++ b/Makefile @@ -20,3 +20,7 @@ endif md-lint: ## Lint markdown files $(ECHO_PREFIX) printf " %-12s ./...\n" "[MD LINT]" $(CMD_PREFIX) podman run --rm -v $(CURDIR):/workdir --security-opt label=disable docker.io/davidanson/markdownlint-cli2:latest > /dev/null + +.PHONY: spellcheck-sort +spellcheck-sort: .spellcheck-en-custom.txt + sort -d -f -o $< $< diff --git a/README.md b/README.md index aa6ce30..50debb8 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ The goals of this open source community includes the following: ## Getting Started with the InstructLab Project workstreams🥼 -InstructLab (**L**arge-scale **A**lignment for chat**B**ots) is an open source initiative by Red Hat and IBM. It provides a platform for easy engagement with Large Language Models (LLM) by using the `ilab` command-line interface (CLI) tool. Users can augment the LLM’s capabilities by submitting the skills and knowledge that they have tested to the project’s taxonomy repository on GitHub by creating a pull request. +InstructLab (**L**arge-scale **A**lignment for chat**B**ots) is an open source initiative by Red Hat and IBM. It provides a platform for easy engagement with Large Language Models (LLM) by using the `ilab` command-line interface (CLI) tool. Users can augment the LLM's capabilities by submitting the skills and knowledge that they have tested to the project’s taxonomy repository on GitHub by creating a pull request. The following documentation shows you an overview of the workflow, and the resources needed, to get started with InstructLab. @@ -67,7 +67,7 @@ To contribute code or documentation, please submit a pull request to the relevan * For more information about general contribution practices, see the [Contributing](https://github.com/instructlab/community/blob/main/CONTRIBUTING.md) guide. * For more information about contributing to the taxonomy repository, see the [Taxonomy's contribution guide](https://github.com/instructlab/taxonomy/blob/main/CONTRIBUTING.md). -* For more information about contributing to the InstructLab CLI repository, see the [Instructlab contribution guide](https://github.com/instructlab/instructlab/blob/main/CONTRIBUTING/CONTRIBUTING.md). +* For more information about contributing to the InstructLab CLI repository, see the [InstructLab contribution guide](https://github.com/instructlab/instructlab/blob/main/CONTRIBUTING/CONTRIBUTING.md). ### Contributor roles @@ -108,7 +108,7 @@ If you would like to see the detailed LICENSE click, see [LICENSE](LICENSE). ## Contact resources -* [InstructLab Slack](https://instruct-lab.slack.com). See the InstuctLab Slack Guide for directions on how to join. +* [InstructLab Slack](https://instruct-lab.slack.com). See the InstructLab Slack Guide for directions on how to join. * [InstructLab Slack Guide](InstructLabSlackGuide.md) * [InstructLab Slack Moderation Guide](InstructLabSlackModerationGuide.md) * [InstructLab Mailing lists](https://github.com/instructlab/community/blob/main/Collaboration.md#aliases-and-mailing-lists-catalog) diff --git a/docs/DataSources.md b/docs/DataSources.md index bc7110c..bb25a9c 100644 --- a/docs/DataSources.md +++ b/docs/DataSources.md @@ -7,7 +7,7 @@ For new contributions to InstructLab that require data along with the submission, we have [thorough guidelines](https://github.com/instructlab/taxonomy/blob/main/CONTRIBUTING.md#for-your-attributiontxt-file) on how to provide attribution for these data sources. -For data used to create the artifacts of the InsructLab project prior to its being open sourced, +For data used to create the artifacts of the InstructLab project prior to its being open sourced, we are [aware that this list is not comprehensive](https://github.com/instructlab/taxonomy/issues/255) at the time of creating it. The project maintainers will augment and update it over time to the best of our abilities. @@ -32,14 +32,14 @@ generation pipeline. | [University Physics volume 3](https://openstax.org/details/books/university-physics-volume-3)  | college_physics | CC-BY-4.0 |**Senior Contributing Authors**: William Moebs, Formerly of Loyola Marymount University; Samuel J. Ling, Truman State University; Jeff Sanny, Loyola Marymount University | Copyright 2021 Rice University | | [Introductory Business Statistics with Interactive Spreadsheets - 1st Canadian Edition](https://opentextbc.ca/introductorybusinessstatistics) | business_statistics | CC-BY-4.0 | Mohammad Mahbobi and Thomas K. Tiemann | Copyright 2015 by Mohammad Mahbobi and Thomas K. Tiemann | | [Principles of Macroeconomics 3e](https://openstax.org/details/books/principles-macroeconomics-3e) | econometrics | CC-BY-4.0 | **Senior Contributing Authors**: David Shapiro, Pennsylvania State University; Daniel MacDonald, California State University, San Bernardino; Steven A. Greenlaw, University of Mary Washington | Copyright 2022 Rice University | -| [Algebra and Trigonometry 2e](https://openstax.org/details/books/algebra-and-trigonometry-2e) | high_school_mathematics | CC-BY-4.0 | **Senior Contributing Author**: Jay Abramson, Arizona State University | Copright 2021 Rice University | -| [Precalculus 2e](https://openstax.org/details/books/precalculus-2e) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Author**: Jay Abramson, Arizona State University | Copright 2021 Rice University | -| [Introductory Business Statistics](https://openstax.org/details/books/introductory-business-statistics) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Authors**: Alexander Holmes, The University of Oklahoma; Barbara Illowsky, De Anza College; Susan Dean, De Anza College | Copright 2018 Rice University | -| [Contemporary Mathematics](https://openstax.org/details/books/contemporary-mathematics) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Author**: Donna Kirk, University of Wisconsin at Superior | Copright 2023 Rice University | -| [Introductory Statistics](https://openstax.org/details/books/introductory-statistics) | high_school_mathmatics | CC-BY-4.0 |**Senior Contributing Authors**: Barbara Illowsky, De Anza College; Susan Dean, De Anza College | Copright 2018 Rice University | -| [Statistics](https://openstax.org/details/books/statistics) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Authors**: Barbara Illowsky, De Anza College; Susan Dean, De Anza College | Copright 2020 Texas Education Agency (TEA) | -| [College Algebra 2e](https://openstax.org/details/books/college-algebra-2e) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Author**: Jay Abramson, Arizona State University | Copright 2021 Rice University | -| [Applied Calculus](https://mathbooks.unl.edu/BCalculus/colophon-1.html) | high_school_mathmatics | CC-BY-SA-4.0 | Kevin Gonzales, Eric Hopkins, Catherine Zimmitti, Cheryl Kane; Modified to fit Applied Calculus from Coordinated Calculus by Nathan Wakefield et. al.; Based upon Active Calculus by Matthew Boelkins | Copyright 2018 - 2021 University of Nebraska - Lincoln, Department of Mathematics| +| [Algebra and Trigonometry 2e](https://openstax.org/details/books/algebra-and-trigonometry-2e) | high_school_mathematics | CC-BY-4.0 | **Senior Contributing Author**: Jay Abramson, Arizona State University | Copyright 2021 Rice University | +| [Precalculus 2e](https://openstax.org/details/books/precalculus-2e) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Author**: Jay Abramson, Arizona State University | Copyright 2021 Rice University | +| [Introductory Business Statistics](https://openstax.org/details/books/introductory-business-statistics) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Authors**: Alexander Holmes, The University of Oklahoma; Barbara Illowsky, De Anza College; Susan Dean, De Anza College | Copyright 2018 Rice University | +| [Contemporary Mathematics](https://openstax.org/details/books/contemporary-mathematics) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Author**: Donna Kirk, University of Wisconsin at Superior | Copyright 2023 Rice University | +| [Introductory Statistics](https://openstax.org/details/books/introductory-statistics) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Authors**: Barbara Illowsky, De Anza College; Susan Dean, De Anza College | Copyright 2018 Rice University | +| [Statistics](https://openstax.org/details/books/statistics) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Authors**: Barbara Illowsky, De Anza College; Susan Dean, De Anza College | Copyright 2020 Texas Education Agency (TEA) | +| [College Algebra 2e](https://openstax.org/details/books/college-algebra-2e) | high_school_mathematics | CC-BY-4.0 |**Senior Contributing Author**: Jay Abramson, Arizona State University | Copyright 2021 Rice University | +| [Applied Calculus](https://mathbooks.unl.edu/BCalculus/colophon-1.html) | high_school_mathematics | CC-BY-SA-4.0 | Kevin Gonzales, Eric Hopkins, Catherine Zimmitti, Cheryl Kane; Modified to fit Applied Calculus from Coordinated Calculus by Nathan Wakefield et al.; Based upon Active Calculus by Matthew Boelkins | Copyright 2018 - 2021 University of Nebraska - Lincoln, Department of Mathematics| | [Coordinated Calculus](https://mathbooks.unl.edu/Calculus) | high_school_mathematics | CC-BY-SA-4.0 | Nathan Wakefield, Christine Kelley, Marla Williams, Michelle Haver, Lawrence Seminario-Romero, Robert Huben, Aurora Marks, Stephanie Prahl; Based upon Active Calculus by Matthew Boelkins | Copyright 2019 University of Nebraska - Lincoln, Department of Mathematics | | [Coordinated Multivariable Calculus](https://mathbooks.unl.edu/MultiVarCalc/colophon-1.html)| high_school_mathematics | CC-BY-NC-SA-4.0 | Steve Schlicker, Mitchel T. Keller, Nicholas Long, Zach Norwood, Audrey Goodnight; Based on Active Calculus | Copyright 2013 - 2022 Steven Schlicker, Mitchel T. Keller, and Nicholas Long | | [Principles of Economics 3e](https://openstax.org/details/books/principles-economics-3e) | high_school_microeconomics | CC-BY-4.0 | **Senior Contributing Authors**: Steven A. Greenlaw, University of Mary Washington; David Shapiro, Pennsylvania State University; Daniel MacDonald, California State University, San Bernardino | Copyright 2022 Rice University | @@ -54,11 +54,11 @@ generation pipeline. | [Intermediate Financial Accounting Volume 1](https://open.umn.edu/opentextbooks/textbooks/intermediate-financial-accounting-volume-1) | financial_accounting | CC-BY-4.0 | Glenn Arnold, Athabasca University and Suzanne Kyle | Copyright 2016 Vretta-Lyryx Inc. | | [Intermediate Financial Accounting Volume 2](https://open.umn.edu/opentextbooks/textbooks/intermediate-financial-accounting-volume-2)) | financial_accounting | CC-BY-4.0 | Glenn Arnold, Athabasca University and Suzanne Kyle | Copyright 2017-2021 Vretta-Lyryx Inc. | | [Introduction to Political Science](https://openstax.org/details/books/introduction-political-science) | political_science | CC-BY-2.0 | **Senior Contributing Authors**: Mark Carl Rom, Georgetown University; Masaki Hidaka, American University; Rachel Bzostek Walker, Collin College | Copyright 2022 Rice University| -| [Introduction to Anthropology](https://openstax.org/details/books/introduction-anthropology) | anthropology | CC-BY-4.0 | **Senior Contributing Authors**: Jennifer Hasty, University of Pennsylvania; David G. Lewis, Oregon State University; Marjorie M. Snipes, University of West Georgia | Copright 2022 Rice University | +| [Introduction to Anthropology](https://openstax.org/details/books/introduction-anthropology) | anthropology | CC-BY-4.0 | **Senior Contributing Authors**: Jennifer Hasty, University of Pennsylvania; David G. Lewis, Oregon State University; Marjorie M. Snipes, University of West Georgia | Copyright 2022 Rice University | ## [Data Sets](#data-sets) -| Dataset Name | Knowledge Taxonomy Location | License and/or Copyright | Other Citiation Information | +| Dataset Name | Knowledge Taxonomy Location | License and/or Copyright | Other Citation Information | | ------------ | --------------------------- | --------------------- | --------- | |[IBM Redbooks](https://www.redbooks.ibm.com/) | ibm_redbooks | Copyright IBM [with some rights available](https://www.redbooks.ibm.com/copyright) | | diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..9bb539d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +# SPDX-License-Identifier: Apache-2.0 + +tox>=4.4.2,<5 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..08591d3 --- /dev/null +++ b/tox.ini @@ -0,0 +1,16 @@ +# SPDX-License-Identifier: Apache-2.0 + +[tox] +envlist = spellcheck +minversion = 4.4 + +[testenv:spellcheck] +description = spell check (needs 'aspell' command) +skip_install = true +skipsdist = true +deps = + pyspelling +commands = + sh -c 'command -v aspell || (echo "aspell is not installed. Please install it." && exit 1)' + {envpython} -m pyspelling --config {toxinidir}/.spellcheck.yml --spellchecker aspell +allowlist_externals = sh