Skip to content

Latest commit

 

History

History
150 lines (99 loc) · 4.06 KB

README.md

File metadata and controls

150 lines (99 loc) · 4.06 KB
Raw

🗄️ Scripts Repository

CI/CD Python Python Build Status Status License: GPL v3

This repository contains a collection of base Python scripts that are invoked by the CI/CD processes of other repositories, especially the template repository. These scripts are used for formatting, checking files, version control, and updating the year in file headers or documentation.

📚 Table of Contents

🌟 Features

  • Formatting Scripts: Format code files according to specified style guidelines.
  • File Checking Scripts: Check files for compliance, correctness, and other criteria.
  • Version Control Scripts: Manage version numbers in your project.
  • Year Update Scripts: Update the year in file headers or documentation.

🚀 Getting Started

To use these scripts in your project, add this repository as a submodule.

🔨 Installation

  1. Add the scripts repository as a submodule in your project:

    git submodule add https://github.com/JuanVilla424/scripts.git

    or, using branch

    git submodule add -b <branch_name> https://github.com/JuanVilla424/scripts.git

  2. Update the submodule when there are changes:

    git submodule update --remote --merge

🤝 Contributing

Contributions are welcome! To contribute to this repository, please follow these steps:

  1. Fork the Repository

  2. Create a Feature Branch

    git checkout -b feature/your-feature-name

  3. Commit Your Changes

    git commit -m "feat(<scope>): your feature commit message - lower case"

  4. Push to the Branch

    git push origin feature/your-feature-name

  5. Open a Pull Request into dev branch

Please ensure your contributions adhere to the Code of Conduct and Contribution Guidelines.

🔧 Environment Setup

Mandatory: Setting Up a Python Virtual Environment

Setting up a Python virtual environment ensures that dependencies are managed effectively and do not interfere with other projects.

  1. Create a Virtual Environment

    python -m venv venv

  2. Activate the Virtual Environment

    On Unix or MacOS:

    source venv/bin/activate

    On Windows:

     powershell.exe -ExecutionPolicy Bypass -File .\venv\Scripts\Activate.ps1

  3. Upgrade pip

    python -m ensurepip
pip install --upgrade pip

  4. Install Dependencies

    pip install -r requirements.txt
pip install poetry
poetry lock
poetry install
    • Deactivate the Virtual Environment

    When you're done, deactivate the environment:

     deactivate

🛸 Pre-Commit Hooks

Install and check pre-commit hooks: MD files changes countermeasures, python format, python lint, yaml format, yaml lint, version control hook, changelog auto-generation

pre-commit install
pre-commit install -t pre-commit
pre-commit install -t pre-push
pre-commit autoupdate
pre-commit run --all-files

📫 Contact

For any inquiries or support, please open an issue or contact [email protected].

📜 License

2024 - This project is licensed under the GNU General Public License v3.0. You are free to use, modify, and distribute this software under the terms of the GPL-3.0 license. For more details, please refer to the LICENSE file included in this repository.