| Name | slim-cli JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | Automation of the application of software lifecycle best practices to your GitHub repositories |
| upload_time | 2024-09-01 22:36:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright (c) 2022 California Institute of Technology ("Caltech"). U.S. Government sponsorship acknowledged. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Caltech nor its operating division, the Jet Propulsion Laboratory, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
| keywords |
ammos
automation
development
nasa
practice
slim
software
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<hr>
<div align="center">
<h1 align="center">SLIM CLI Tool</h1>
</div>
<pre align="center">Automate the application of best practices to your git repositories</pre>
<!-- Header block for project -->
[](https://nasa-ammos.github.io/slim/)
<!-- ☝️ Add badges via: https://shields.io e.g.  ☝️ -->
<img width="1242" alt="slim-cli-screen" src="https://github.com/user-attachments/assets/5a38e016-04ea-4e4d-b2b8-5e443367c899">
SLIM CLI is a command-line tool designed to infuse SLIM best practices seamlessly with your development workflow. It fetches and applies structured SLIM best practices directly into your Git repositories. The tool leverages artificial intelligence capabilities to customize and tailor the application of SLIM best practices based on your repository's specifics.
[Website](https://nasa-ammos.github.io/slim/) | [Docs/Wiki](https://nasa-ammos.github.io/slim/docs) | [Discussion Board](https://nasa-ammos.github.io/slim/forum) | [Issue Tracker](https://github.com/NASA-AMMOS/slim-cli/issues)
## Features
- Command-line interface for applying SLIM best practices into Git development workflows.
- Fetches the latest SLIM best practices dynamically from SLIM's registry.
- Allows customization of best practices using advanced AI models before applying them to repositories.
- Deploys, or git adds, commits, and pushes changes to your repository's remote.
## Contents
- [Features](#features)
- [Contents](#contents)
- [Quick Start](#quick-start)
- [Requirements](#requirements)
- [Setup Instructions](#setup-instructions)
- [Run Instructions](#run-instructions)
- [Changelog](#changelog)
- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
- [Contributing](#contributing)
- [License](#license)
- [Support](#support)
## Quick Start
This guide provides a quick way to get started with our project. Please see our [docs](https://nasa-ammos.github.io/slim/docs) for a more comprehensive overview.
### Requirements
* Python 3.7+
* Git
* `.env` file to properly configure the environment for Azure and OpenAI APIs
```bash
# .env for Azure
AZURE_TENANT_ID=<Your-Azure-Tenant-ID>
AZURE_CLIENT_ID=<Your-Azure-Client-ID>
AZURE_CLIENT_SECRET=<Your-Azure-Client-Secret>
API_ENDPOINT=<Your-Azure-OpenAI-API-Endpoint>
API_VERSION=<Azure-OpenAI-API-Version>
APIM_SUBSCRIPTION_KEY=<Your-Azure-Subscription-Key>
```
```bash
# .env for OpenAI
OPENAI_API_KEY=<Your-OpenAI-API-Key>
```
### Setup Instructions
As the SLIM CLI is written in Python, you'll need Python 3.7 or later. Usually, you'll want to create a virtual environment in order to isolate the dependencies of SLIM from other Python-using applications. Install into that environment using `pip`:
pip install slim-cli
This installs the latest SLIM CLI and its dependencies from the [Python Package Index](https://pypi.org/). The new console script `slim` is now ready for use. Confirm by running either:
slim --version
slim --help
To upgrade:
pip install --upgrade slim-cli
Or select a specific version, such as `X.Y.Z`:
pip install slim-cli==X.Y.Z
### Run Instructions
This section provides detailed commands to interact with the SLIM CLI. Each command includes various options that you can specify to tailor the tool's behavior to your needs.
1. **List all available best practices**
- This command lists all best practices fetched from the SLIM registry.
```bash
slim list
```
2. **Apply best practices to repositories**
- This command applies specified best practices to one or more repositories. It supports applying multiple practices simultaneously across multiple repositories, with AI customization options available.
- `--best-practice-ids`: List of best practice IDs to apply.
- `--repo-urls`: List of repository URLs to apply the best practices to; not used if `--repo-dir` is specified.
- `--repo-dir`: Local directory path of the repository where the best practices will be applied.
- `--clone-to-dir`: Path where the repository should be cloned if not present locally. Compatible with `--repo-urls`.
- `--use-ai`: Enables AI features to customize the application of best practices based on the project’s specific needs. Specify the model provider and model name as an argument (e.g., `azure/gpt-4o`).
```bash
slim apply --best-practice-ids SLIM-123 SLIM-456 --repo-urls https://github.com/your-username/your-repo1 https://github.com/your-username/your-repo2
```
- To apply a best practice using AI customization:
```bash
# Apply a specific best practice using AI customization
slim apply --best-practice-ids SLIM-123 --repo-urls https://github.com/your_org/your_repo.git --use-ai <model provider>/<model name>
```
Example usage:
```bash
# Apply and deploy a best practice using Azure's GPT-4o model
slim apply --best-practice-ids SLIM-3.1 --repo-urls https://github.com/riverma/terraformly/ --use-ai azure/gpt-4o
```
```bash
# Apply and deploy a best practice using Ollama's LLaMA 3.1 model
slim apply --best-practice-ids SLIM-3.1 --repo-urls https://github.com/riverma/terraformly/ --use-ai ollama/llama3.1:405b
```
3. **Deploy a best practice**
- After applying best practices, you may want to deploy (commit and push) them to a remote repository.
- `--best-practice-ids`: List of best practice IDs that have been applied and are ready for deployment.
- `--repo-dir`: The local directory of the repository where changes will be committed and pushed.
- `--remote-name`: Specifies the remote name in the git configuration to which the changes will be pushed.
- `--commit-message`: A message describing the changes for the commit.
```bash
slim deploy --best-practice-ids SLIM-123 SLIM-456 --repo-dir /path/to/repo --remote-name origin --commit-message "Apply SLIM best practices"
```
4. **Apply and deploy a best practice**
- Combines the application and deployment of a best practice into one step.
- `--best-practice-ids`: List of best practice IDs to apply and then deploy.
- `--repo-urls`: List of repository URLs for cloning if not already cloned; not used if `--repo-dir` is specified.
- `--repo-dir`: Specifies the directory of the repository where the best practice will be applied and changes committed.
- `--remote-name`: Specifies the remote to which the changes will be pushed.
- `--commit-message`: A message describing the changes for the commit.
- `--use-ai`: If specified, enables AI customization of the best practice before applying. False by default.
```bash
slim apply-deploy --best-practice-ids SLIM-123 --repo-urls https://github.com/your-username/your-repo1 https://github.com/your-username/your-repo2 --remote-name origin --commit-message "Integrated SLIM best practice with AI customization"
```
Example output:
```
AI features disabled
Applied best practice SLIM-123 and committed to branch slim-123
Pushed changes to remote origin on branch slim-123
```
Each command can be modified with additional flags as needed for more specific tasks or environments.
## Changelog
See our [CHANGELOG.md](CHANGELOG.md) for a history of our changes.
See our [releases page](https://github.com/NASA-AMMOS/slim-cli/releases) for our key versioned releases.
## Frequently Asked Questions (FAQ)
Questions about our project? Please see our: [FAQ](https://nasa-ammos.github.io/slim/faq)
## Contributing
Interested in contributing to our project? Please see our: [CONTRIBUTING.md](CONTRIBUTING.md)
For guidance on how to interact with our team, please see our code of conduct located at: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
For guidance on our governance approach, including decision-making process and our various roles, please see our governance model at: [GOVERNANCE.md](GOVERNANCE.md)
### Local Development
For local development of SLIM CLI, clone the GitHub repository, create a virtual environment, and then install the package in editable mode into it:
```bash
git clone --quiet https://github.com/NASA-AMMOS/slim-cli.git
cd slim-cli
python3 -m venv .venv
source .venv/bin/activate
pip install --editable .
```
The `slim` console-script is now ready in editable mode; changes you make to the source files under `src` are immediately reflected when run.
To publish a new version of SLIM CLI to the Python Package Index, typically you'll update the `VERSION.txt` file; then do:
```bash
pip install build wheel twine
python3 -m build .
twine upload dist/*
```
(Note: this can and should eventually be automated with GitHub Actions.)
## License
See our: [LICENSE](LICENSE)
## Support
Key points of contact are: [@riverma](https://github.com/riverma) and [@yunks128](https://github.com/yunks128)
Raw data
{
"_id": null,
"home_page": null,
"name": "slim-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "ammos, automation, development, nasa, practice, slim, software",
"author": null,
"author_email": "Rishi Verma <Rishi.Verma@jpl.nasa.gov>, Kyongsik Yun <kyongsik.yun@jpl.nasa.gov>, Sean Kelly <kelly@seankelly.biz>",
"download_url": "https://files.pythonhosted.org/packages/7d/80/83cc6647f71d9b3c963ede3dd7632e869602b70bcd1f6a15e6d8ef0fbedb/slim_cli-0.0.3.tar.gz",
"platform": null,
"description": "<hr>\n\n<div align=\"center\">\n\n<h1 align=\"center\">SLIM CLI Tool</h1>\n\n</div>\n\n<pre align=\"center\">Automate the application of best practices to your git repositories</pre>\n\n<!-- Header block for project -->\n[](https://nasa-ammos.github.io/slim/)\n<!-- \u261d\ufe0f Add badges via: https://shields.io e.g.  \u261d\ufe0f -->\n\n<img width=\"1242\" alt=\"slim-cli-screen\" src=\"https://github.com/user-attachments/assets/5a38e016-04ea-4e4d-b2b8-5e443367c899\">\n\nSLIM CLI is a command-line tool designed to infuse SLIM best practices seamlessly with your development workflow. It fetches and applies structured SLIM best practices directly into your Git repositories. The tool leverages artificial intelligence capabilities to customize and tailor the application of SLIM best practices based on your repository's specifics.\n\n[Website](https://nasa-ammos.github.io/slim/) | [Docs/Wiki](https://nasa-ammos.github.io/slim/docs) | [Discussion Board](https://nasa-ammos.github.io/slim/forum) | [Issue Tracker](https://github.com/NASA-AMMOS/slim-cli/issues)\n\n## Features\n\n- Command-line interface for applying SLIM best practices into Git development workflows.\n- Fetches the latest SLIM best practices dynamically from SLIM's registry.\n- Allows customization of best practices using advanced AI models before applying them to repositories.\n- Deploys, or git adds, commits, and pushes changes to your repository's remote.\n \n## Contents\n\n- [Features](#features)\n- [Contents](#contents)\n- [Quick Start](#quick-start)\n - [Requirements](#requirements)\n - [Setup Instructions](#setup-instructions)\n - [Run Instructions](#run-instructions)\n- [Changelog](#changelog)\n- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)\n- [Contributing](#contributing)\n- [License](#license)\n- [Support](#support)\n\n## Quick Start\n\nThis guide provides a quick way to get started with our project. Please see our [docs](https://nasa-ammos.github.io/slim/docs) for a more comprehensive overview.\n\n### Requirements\n\n* Python 3.7+\n* Git\n* `.env` file to properly configure the environment for Azure and OpenAI APIs\n ```bash\n # .env for Azure\n AZURE_TENANT_ID=<Your-Azure-Tenant-ID>\n AZURE_CLIENT_ID=<Your-Azure-Client-ID>\n AZURE_CLIENT_SECRET=<Your-Azure-Client-Secret>\n API_ENDPOINT=<Your-Azure-OpenAI-API-Endpoint>\n API_VERSION=<Azure-OpenAI-API-Version>\n APIM_SUBSCRIPTION_KEY=<Your-Azure-Subscription-Key>\n ```\n ```bash\n # .env for OpenAI\n OPENAI_API_KEY=<Your-OpenAI-API-Key>\n ```\n\n \n### Setup Instructions\n\nAs the SLIM CLI is written in Python, you'll need Python 3.7 or later. Usually, you'll want to create a virtual environment in order to isolate the dependencies of SLIM from other Python-using applications. Install into that environment using `pip`:\n\n pip install slim-cli\n\nThis installs the latest SLIM CLI and its dependencies from the [Python Package Index](https://pypi.org/). The new console script `slim` is now ready for use. Confirm by running either:\n\n slim --version\n slim --help\n\nTo upgrade:\n\n pip install --upgrade slim-cli\n\nOr select a specific version, such as `X.Y.Z`:\n\n pip install slim-cli==X.Y.Z\n\n\n### Run Instructions\n\nThis section provides detailed commands to interact with the SLIM CLI. Each command includes various options that you can specify to tailor the tool's behavior to your needs.\n\n1. **List all available best practices**\n - This command lists all best practices fetched from the SLIM registry.\n ```bash\n slim list\n ```\n\n2. **Apply best practices to repositories**\n - This command applies specified best practices to one or more repositories. It supports applying multiple practices simultaneously across multiple repositories, with AI customization options available.\n - `--best-practice-ids`: List of best practice IDs to apply.\n - `--repo-urls`: List of repository URLs to apply the best practices to; not used if `--repo-dir` is specified.\n - `--repo-dir`: Local directory path of the repository where the best practices will be applied.\n - `--clone-to-dir`: Path where the repository should be cloned if not present locally. Compatible with `--repo-urls`.\n - `--use-ai`: Enables AI features to customize the application of best practices based on the project\u2019s specific needs. Specify the model provider and model name as an argument (e.g., `azure/gpt-4o`).\n ```bash\n slim apply --best-practice-ids SLIM-123 SLIM-456 --repo-urls https://github.com/your-username/your-repo1 https://github.com/your-username/your-repo2 \n ```\n - To apply a best practice using AI customization:\n ```bash\n # Apply a specific best practice using AI customization\n slim apply --best-practice-ids SLIM-123 --repo-urls https://github.com/your_org/your_repo.git --use-ai <model provider>/<model name>\n ```\n Example usage: \n ```bash\n # Apply and deploy a best practice using Azure's GPT-4o model\n slim apply --best-practice-ids SLIM-3.1 --repo-urls https://github.com/riverma/terraformly/ --use-ai azure/gpt-4o\n ```\n ```bash\n # Apply and deploy a best practice using Ollama's LLaMA 3.1 model\n slim apply --best-practice-ids SLIM-3.1 --repo-urls https://github.com/riverma/terraformly/ --use-ai ollama/llama3.1:405b\n ```\n \n3. **Deploy a best practice**\n - After applying best practices, you may want to deploy (commit and push) them to a remote repository.\n - `--best-practice-ids`: List of best practice IDs that have been applied and are ready for deployment.\n - `--repo-dir`: The local directory of the repository where changes will be committed and pushed.\n - `--remote-name`: Specifies the remote name in the git configuration to which the changes will be pushed.\n - `--commit-message`: A message describing the changes for the commit.\n ```bash\n slim deploy --best-practice-ids SLIM-123 SLIM-456 --repo-dir /path/to/repo --remote-name origin --commit-message \"Apply SLIM best practices\"\n ```\n\n4. **Apply and deploy a best practice**\n - Combines the application and deployment of a best practice into one step.\n - `--best-practice-ids`: List of best practice IDs to apply and then deploy.\n - `--repo-urls`: List of repository URLs for cloning if not already cloned; not used if `--repo-dir` is specified.\n - `--repo-dir`: Specifies the directory of the repository where the best practice will be applied and changes committed.\n - `--remote-name`: Specifies the remote to which the changes will be pushed.\n - `--commit-message`: A message describing the changes for the commit.\n - `--use-ai`: If specified, enables AI customization of the best practice before applying. False by default.\n ```bash\n slim apply-deploy --best-practice-ids SLIM-123 --repo-urls https://github.com/your-username/your-repo1 https://github.com/your-username/your-repo2 --remote-name origin --commit-message \"Integrated SLIM best practice with AI customization\"\n ```\n Example output:\n ```\n AI features disabled\n Applied best practice SLIM-123 and committed to branch slim-123\n Pushed changes to remote origin on branch slim-123\n ```\n\nEach command can be modified with additional flags as needed for more specific tasks or environments.\n\n## Changelog\n\nSee our [CHANGELOG.md](CHANGELOG.md) for a history of our changes.\n\nSee our [releases page](https://github.com/NASA-AMMOS/slim-cli/releases) for our key versioned releases.\n\n## Frequently Asked Questions (FAQ)\n\nQuestions about our project? Please see our: [FAQ](https://nasa-ammos.github.io/slim/faq)\n\n## Contributing\n\nInterested in contributing to our project? Please see our: [CONTRIBUTING.md](CONTRIBUTING.md)\n\nFor guidance on how to interact with our team, please see our code of conduct located at: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)\n\nFor guidance on our governance approach, including decision-making process and our various roles, please see our governance model at: [GOVERNANCE.md](GOVERNANCE.md)\n\n\n### Local Development\n\nFor local development of SLIM CLI, clone the GitHub repository, create a virtual environment, and then install the package in editable mode into it:\n```bash\ngit clone --quiet https://github.com/NASA-AMMOS/slim-cli.git\ncd slim-cli\npython3 -m venv .venv\nsource .venv/bin/activate\npip install --editable .\n```\n\nThe `slim` console-script is now ready in editable mode; changes you make to the source files under `src` are immediately reflected when run.\n\nTo publish a new version of SLIM CLI to the Python Package Index, typically you'll update the `VERSION.txt` file; then do:\n```bash\npip install build wheel twine\npython3 -m build .\ntwine upload dist/*\n```\n\n(Note: this can and should eventually be automated with GitHub Actions.)\n\n\n## License\n\nSee our: [LICENSE](LICENSE)\n\n## Support\n\nKey points of contact are: [@riverma](https://github.com/riverma) and [@yunks128](https://github.com/yunks128)\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright (c) 2022 California Institute of Technology (\"Caltech\"). U.S. Government sponsorship acknowledged. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Caltech nor its operating division, the Jet Propulsion Laboratory, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
"summary": "Automation of the application of software lifecycle best practices to your GitHub repositories",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/SLIM/slim-cli",
"Issues": "https://github.com/SLIM/slim-cli/issues"
},
"split_keywords": [
"ammos",
" automation",
" development",
" nasa",
" practice",
" slim",
" software"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6692262cbde2efb4a297912befb02aec15fa94b0b37b54c69a63452b7bc7756e",
"md5": "af5603c0554d0f2456a053ea70deba3a",
"sha256": "bab9aa6a096de2e6840268be98558d52454e4900b94569e3bfb9cdfbe877a530"
},
"downloads": -1,
"filename": "slim_cli-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af5603c0554d0f2456a053ea70deba3a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 23160,
"upload_time": "2024-09-01T22:36:36",
"upload_time_iso_8601": "2024-09-01T22:36:36.296676Z",
"url": "https://files.pythonhosted.org/packages/66/92/262cbde2efb4a297912befb02aec15fa94b0b37b54c69a63452b7bc7756e/slim_cli-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7d8083cc6647f71d9b3c963ede3dd7632e869602b70bcd1f6a15e6d8ef0fbedb",
"md5": "5506136a0c44b7fc64ced2c8390e3203",
"sha256": "17d31300607569fae093249ac2e34c10eed24538e206aace2608c82f93b62680"
},
"downloads": -1,
"filename": "slim_cli-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "5506136a0c44b7fc64ced2c8390e3203",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 35138,
"upload_time": "2024-09-01T22:36:37",
"upload_time_iso_8601": "2024-09-01T22:36:37.480194Z",
"url": "https://files.pythonhosted.org/packages/7d/80/83cc6647f71d9b3c963ede3dd7632e869602b70bcd1f6a15e6d8ef0fbedb/slim_cli-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-01 22:36:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SLIM",
"github_project": "slim-cli",
"github_not_found": true,
"lcname": "slim-cli"
}
