https://github.com/thealgorithms/scripts

Scripts used across all The Algorithms repositories
https://github.com/thealgorithms/scripts

bash file-formatter formatter hacktoberfest python python3 script scripts

Last synced: about 1 month ago
JSON representation

Scripts used across all The Algorithms repositories

• Host: GitHub
• URL: https://github.com/thealgorithms/scripts
• Owner: TheAlgorithms
• License: mit
• Created: 2021-04-22T21:20:42.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-04T22:33:06.000Z (about 1 year ago)
• Last Synced: 2024-10-29T21:05:59.498Z (about 2 months ago)
• Topics: bash, file-formatter, formatter, hacktoberfest, python, python3, script, scripts
• Language: Python
• Homepage:
• Size: 32.2 KB
• Stars: 77
• Watchers: 9
• Forks: 44
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# The Algorithms Scripts

  

Internal scripts used across all The Algorithms repositories

## build_directory_md.py

This script should be run by a workflow on every push and pr to update the `DIRECTORY.md` file. It takes the following arguments:

```

[0] - Language

[1] - Base path

[2] - Allowed filenames

[3] - Files or folders to ignore (optional)

[4] - Folders to ignore, but include children (optional)

```

For example, the command for the C++ repo would be:

```bash

python3 build_directory_md.py C-Plus-Plus . .cpp,.hpp,.h > DIRECTORY.md

```

Or more advanced, for the MATLAB / Octave repo:

```bash

python3 build_directory_md.py MATLAB-Octave . .m - algorithms > DIRECTORY.md