This tool is designed to facilitate the management of projects within the Open Publishing Environment (OPE). It includes a variety of functions for handling repositories, books, containers, and course creation.
- Clone this repository to your local machine.
- Ensure you have Git installed, as it is required for several functions.
- Command: In the directory, run
./install.sh
Each function in the script is intended for specific tasks. Below are the usages and descriptions for each function.
- Usage: Run the tool with a specific command and relevant arguments.
- Command:
ope <function> [arguments]
- Description: Creates a new OPE project from templates.
- Usage:
ope new_project <project_name> [repo_url] - Arguments:
project_name: Name of the new project.repo_url(optional): URL of the Git repository to associate with the project.
- Description: Creates a new book within the project.
- Usage:
ope new_book <book_name> - Arguments:
book_name: Name of the new book.
- Description: Adds source for building a new container for the project.
- Usage:
ope new_container <container_name> - Arguments:
container_name: Name of the new container.
- Description: Creates a new course with a standard set of books and a container.
- Usage:
ope new_course <course_name> [repo_url] - Arguments:
course_name: Name of the new course.repo_url(optional): URL of the Git repository for the course.
- Description: Updates and rebases changes from the OPE framework.
- Usage:
ope update - No arguments required.
repo_add: Adds a repository to a project.findprojectdir: Finds the project directory.projectdir: Outputs the project directory.new_part: Creates a new part in a book or course.print_func_page: Prints the help page for functions.Usage: Prints general usage information.
- The script includes logging functionality. Check
/tmp/ope.<process_id>.logfor logs. - Color configuration is included for better readability of output.
This project is licensed under the MIT License. See the LICENSE file for details.