# introduction
The `rats-devtools` component provides a suite of tools to automate and streamline the development
workflow for any application. It offers commands for tasks such as CI pipeline checks,
container image building, documentation generation, and other essential development operations that
support, but are not directly part of, your product. While originally developed for this project,
`rats-devtools` is now designed for general use and can help teams enforce best practices and
maintain high-quality development environments across different projects.
Typically, the commands provided by this component are installed repo-wide, and are able to support
both monorepos, and single-component code bases. The tools for the development of `rats` components
can be installed with the `rats.setup` script found in the `bin/` folder.
```bash
cd rats
direnv allow .
rats.setup
```
You can configure shell-completion for the duration of your session with the commands below:
``` bash
eval "$(_RATS_AML_COMPLETE=zsh_source rats-aml)"
eval "$(_RATS_CI_COMPLETE=zsh_source rats-ci)"
eval "$(_RATS_DOCS_COMPLETE=zsh_source rats-docs)"
eval "$(_RATS_EZ_COMPLETE=zsh_source rats-ez)"
eval "$(_RATS_RUNTIME_COMPLETE=zsh_source rats-runtime)"
```
The commands in this component are also used by our CI pipelines, so will give you a good way
to validate your changes before submitting a pull request.
Raw data
{
"_id": null,
"home_page": null,
"name": "rats-devtools",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "pipelines, machine learning, research",
"author": "Elon Portugaly",
"author_email": "elonp@microsoft.com",
"download_url": null,
"platform": null,
"description": "# introduction\n\nThe `rats-devtools` component provides a suite of tools to automate and streamline the development\nworkflow for any application. It offers commands for tasks such as CI pipeline checks,\ncontainer image building, documentation generation, and other essential development operations that\nsupport, but are not directly part of, your product. While originally developed for this project,\n`rats-devtools` is now designed for general use and can help teams enforce best practices and\nmaintain high-quality development environments across different projects.\n\nTypically, the commands provided by this component are installed repo-wide, and are able to support\nboth monorepos, and single-component code bases. The tools for the development of `rats` components\ncan be installed with the `rats.setup` script found in the `bin/` folder.\n\n```bash\ncd rats\ndirenv allow .\nrats.setup\n```\n\nYou can configure shell-completion for the duration of your session with the commands below:\n\n``` bash\neval \"$(_RATS_AML_COMPLETE=zsh_source rats-aml)\"\neval \"$(_RATS_CI_COMPLETE=zsh_source rats-ci)\"\neval \"$(_RATS_DOCS_COMPLETE=zsh_source rats-docs)\"\neval \"$(_RATS_EZ_COMPLETE=zsh_source rats-ez)\"\neval \"$(_RATS_RUNTIME_COMPLETE=zsh_source rats-runtime)\"\n```\n\nThe commands in this component are also used by our CI pipelines, so will give you a good way\nto validate your changes before submitting a pull request.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Rats Development Tools",
"version": "0.14.0",
"project_urls": {
"Documentation": "https://microsoft.github.io/rats",
"Repository": "https://github.com/microsoft/rats"
},
"split_keywords": [
"pipelines",
" machine learning",
" research"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e0927105e0755aae9312ca88e55e9ab4e12df2e1e420eecb9a33177328272ad2",
"md5": "a0063b5f1792f13be60cc8087de74b5d",
"sha256": "056b24c73c8915a035e451d388aba896ba85d107c0bb43b9bd67862df9352962"
},
"downloads": -1,
"filename": "rats_devtools-0.14.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0063b5f1792f13be60cc8087de74b5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 47818,
"upload_time": "2025-07-17T15:43:35",
"upload_time_iso_8601": "2025-07-17T15:43:35.316388Z",
"url": "https://files.pythonhosted.org/packages/e0/92/7105e0755aae9312ca88e55e9ab4e12df2e1e420eecb9a33177328272ad2/rats_devtools-0.14.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-17 15:43:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "microsoft",
"github_project": "rats",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rats-devtools"
}
JSON
