JOJ/JOJ3-config-generator
27
1
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity
A CLI tool that generates configuration files for JOJ3.
202 Commits 2 Branches 0 Tags 931 KiB
Python 100%
789137d498
Go to file
李衍志523370910113 789137d498
Some checks failed
build / build (push) Failing after 2m27s
Details
build / build (pull_request) Failing after 2m26s
Details
docs: update README
2025-02-27 10:07:17 +08:00
.gitea/workflows ci: use local checkout 2025-02-25 03:12:25 -05:00
joj3_config_generator refactor(convert): remove distribute json 2025-02-27 09:58:19 +08:00
tests fix: conflict with master 2025-02-27 09:49:16 +08:00
.editorconfig chore: simple .editorconfig 2024-10-03 22:58:24 -04:00
.gitignore chore: remove useless files 2025-02-24 22:12:35 +08:00
.pre-commit-config.yaml chore: remove all unused imports 2024-11-09 19:42:19 -05:00
LICENSE chore: cleanup & setup pdm 2024-10-17 18:28:01 -04:00
pyproject.toml chore: remove useless files 2025-02-24 22:12:35 +08:00
README.md docs: update README 2025-02-27 10:07:17 +08:00

README.md

JOJ3-config-generator

Getting Started

For users

  1. Install Python>=3.9 and pip
  2. Install the project by pip install git+ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3-config-generator.git
  3. Run it by joj3-config-generator --help

For developers

  1. Clone this repo by git clone ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3-config-generator.git
  2. Install Python>=3.9 and PDM
  3. Change dir to the repo, cd JOJ3-config-generator
  4. Install deps by pdm install && pdm run pre-commit install
  5. Run the cli app by pdm run app --help
  6. Check other commands or scripts with pdm run --list

How to use?

  • joj3-config-generator convert function is now supported, currently support one argument as input, it indicates the convert root

    • default value on the server can be given as /home/tt/.config/joj
    • NOTE: the user should ensure that the ideal repo.toml file is in the sub-directory of the convert root
    • the intended immutable files should be placed at same position as the repo.toml file

  • sample command on the server

joj3-config-generator convert /home/tt/.config/joj