jCloud/jcloud-docsgen
2
1 Fork 0
generated from jCloud/repository-template
Code Issues 3 Pull Requests Actions Packages Projects 1 Releases 13 Wiki Activity

Feat(cli): add base command-line interface #16

Merged
jakob.scheid merged 21 commits from feature/cli into main 2026-09-13 20:11:00 +02:00
Conversation 1 Commits 21 Files Changed 13
+626 -38
jakob.scheid commented 2026-09-13 20:00:02 +02:00
Owner
Copy link
Copy source

Base command-line interface

This pull request adds a base command-line interface:

  • subcommands for languages:
    • Python subcommand with options for allowing HTML, allowing Markdown tables, sections included, and sections excluded
  • unit tests for CLI
  • integration tests for CLI

cli is now a package instead of a module.

Related issues

Closes #15

# Base command-line interface This pull request adds a base command-line interface: - subcommands for languages: - Python subcommand with options for allowing HTML, allowing Markdown tables, sections included, and sections excluded - unit tests for CLI - integration tests for CLI `cli` is now a package instead of a module. ## Related issues Closes #15
jakob.scheid added this to the 0.2.0 milestone 2026-09-13 20:00:02 +02:00
jakob.scheid added the Kind/Feature
Priority
High
2
Kind/Urgent labels 2026-09-13 20:00:02 +02:00
jakob.scheid added this to the Project Board project 2026-09-13 20:00:02 +02:00
jakob.scheid added 19 commits 2026-09-13 20:00:02 +02:00
feat(cli): make project_directory argument optional 436dacf806
feat(cli): add output directory option 2d6de2028f
refactor(cli)!: make CLI a package 350f8f9941
feat(cli): add Python CLI handling bce073746e 
Added a subparser for Python documentation and a function to generate
Python documentation.
chore: add project script 34457f0b9f 
Added the script 'jcloud-docsgen' to pyproject.toml so that jCloud Docsgen can
be run directly without using 'python3 -m ...'.
docs(changelog): add CLI entry to changelog a8513a78e2
feat(cli): allow to pass command line arguments to function 60a097f0cc
feat(cli): add error handling 3ab9884be0 
The CLI now handles error that may result from user input and prints an
error message. Following error types are handled:
 - file not found
 - not a directory
 - directory instead of file
 - file exists
 - permission error
 - general operating system errors
 - Unicode errors
 - errors parsing project source code

Additionally, KeyboardInterrupt and BrokenPipeError are catched and an
appropriate exit code is returned.
refactor(cli): move parser creation to a function 29d1c5bced
feat(cli): add __all__ to cli.cli module db0d36f956
refactor(cli): rename 'parsers' package to 'languages' 348be4f07f
test(cli): add tests for the CLI 84fe67230f
docs(changelog): update CLI entry e2e6a59d13
feat(cli): import languages package 8f5dc33369
feat(cli): add cli module to cli package __init__ module 2cb99d4ca9
feat: add __main__ module 8644232a00 
Added a __main__ module that calls the CLI main function.
refactor(cli): move sections list parsing to function 089cf5f2ff
fix(cli): copy VALID_SECTIONS when parsing sections list 5e84156e01
test(cli): add tests for Python sections list parser bd7780f112
pyproject.toml Outdated
@@ -11,2 +11,4 @@
license = "Apache-2.0"
[project.scripts]
jcloud-docsgen = "jcloud_docsgen.cli.cli:main"
jakob.scheid commented 2026-09-13 20:05:48 +02:00
Author
Owner
Copy link
Copy source

Please use jcloud_docsgen.cli:main.

Please use `jcloud_docsgen.cli:main`.
jakob.scheid marked this conversation as resolved
src/jcloud_docsgen/cli/cli.py
@@ -0,0 +16,4 @@
The command line interface
'''
__all__ = [
jakob.scheid commented 2026-09-13 20:03:36 +02:00
Author
Owner
Copy link
Copy source

This is redundant.

This is redundant.
jakob.scheid marked this conversation as resolved
jakob.scheid added 1 commit 2026-09-13 20:09:28 +02:00
fix: jcloud_docsgen.cli instead of jcloud_docsgen.cli.cli in pyproject.toml 56588e6c78
jakob.scheid added 1 commit 2026-09-13 20:10:43 +02:00
refactor(cli): remove unnecessary, redundant __all__ 1ce3d8f9d1
jakob.scheid merged commit 8930efc7e6 into main 2026-09-13 20:11:00 +02:00
jakob.scheid deleted branch feature/cli 2026-09-13 20:11:00 +02:00
jakob.scheid moved this to Review in Project Board on 2026-09-13 20:11:04 +02:00
jakob.scheid moved this to Done in Project Board on 2026-09-13 20:11:10 +02:00
jakob.scheid added the Kind/Documentation label 2026-09-22 13:26:25 +02:00
jakob.scheid changed title from Feature(cli): add base command-line interface to Feat(cli): add base command-line interface 2026-09-22 19:15:53 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
jakob.scheid
Labels
Clear labels
Compat/Breaking
Breaking change that will not be backward compatible
 Kind/Bug
Something is not working
 Kind/Chore
Chore and maintenance
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Refactor
Refactoring code
 Kind/Security
This is security issue
 Kind/Style
Code style changes
 Kind/Testing
Issue or pull request related to testing
 Kind/Urgent
The issue or pull request is urgent
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Medium
3
The priority is medium
Priority
Low
4
The priority is low
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Will Not Fix
3
This issue won't be fixed
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
Status
Abandoned
3
Somebody has started to work on this but abandoned work
No labels Kind/Documentation Kind/Feature Kind/Urgent
Priority
High
2
Milestone
No items
No Milestone 0.2.0
Projects
Clear projects
No projects
Project Board
Done
Assignees
Clear assignees
jakob.scheid (Jakob Scheid) jcloud-bot (jCloudBot) Bot
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: jCloud/jcloud-docsgen#16