Commit Graph
57 Commits
Author SHA1 Message Date
jakob.scheid 17c5e4938f test(python-generator): update tests for PEP 8 compliance
Updated test cases to the new default value PEP 8 compliance and added
new test cases to test the new behavior.
2026-09-22 16:13:23 +02:00
jakob.scheid cc786a6c69 fix(python-generator): make signatures compliant with PEP 8
The '=' character at a parameter in the signature was surrounded with
spaces previously. That is no longer the case, unless there is a type
hint.
2026-09-22 15:55:57 +02:00
jakob.scheid 62206db574 docs(changelog): add entry for API reference pipeline
Added a changelog entry for the CI pipeline which generated the API
reference.
2026-09-22 13:16:35 +02:00
jakob.scheid 89451c34e3 chore(ci): add workflow to generate API reference
Added a workflow which generates the API reference and commits and
pushes it.
2026-09-22 13:15:47 +02:00
jakob.scheid 1a230abf02 docs(changelog): add package registry reference entry
Added an entry for the installation instructions update in README to the
changelog.
2026-09-22 12:43:19 +02:00
jakob.scheid 14d6a8984a docs(readme): update installation instructions
Previously, there were instructions how to install the package (over the
old registry) in README.md. They were replaced with a reference to the
Gitea Package Registry.
2026-09-22 12:37:10 +02:00
jakob.scheid 25a92d710e chore: add setup script
Added a setup script in scripts/ to configure Git to use the commit
message template and added a reference to it to README.md.
2026-09-21 22:27:28 +02:00
jakob.scheid a55d4d4f79 chore: add commit message template
Added a commit message template for conventional commits line
length limits.
2026-09-21 22:21:40 +02:00
jakob.scheid 0e81d0b9ca refactor(python-generator): rename misnamed testing function
Renamed 'test_PythonPackageNamespace___getitem__' to
'test_PythonPackageNamespace_add'.
2026-09-21 22:12:00 +02:00
jakob.scheid de3eac3bb1 chore: lint source code using Ruff 2026-09-21 20:10:09 +02:00
jakob.scheid aa4a139878 style: format source code using Ruff 2026-09-21 20:10:04 +02:00
jakob.scheid d9887f34c9 chore(ruff): add Ruff configuration 2026-09-18 22:40:39 +02:00
jakob.scheid 178e6b0bd8 chore(deps): add Ruff dependency 2026-09-18 22:31:09 +02:00
jakob.scheid 475775eb7e style: ensure trailing commas in multi-line statements 2026-09-18 22:18:13 +02:00
jakob.scheid 23e450e9df style: remove trailing whitespace
Removed all trailing whitespace.
2026-09-18 17:02:09 +02:00
jakob.scheid caa8e04047 style: limit line length to 79 characters
Limited the lengths of all lines to 79 characters (if possible).
Additionally, some other lines were breaked for consistence.
2026-09-18 16:57:45 +02:00
jakob.scheid 1ce3d8f9d1 refactor(cli): remove unnecessary, redundant __all__ 2026-09-13 20:10:22 +02:00
jakob.scheid 56588e6c78 fix: jcloud_docsgen.cli instead of jcloud_docsgen.cli.cli in pyproject.toml 2026-09-13 20:09:02 +02:00
jakob.scheid bd7780f112 test(cli): add tests for Python sections list parser 2026-09-13 19:04:55 +02:00
jakob.scheid 5e84156e01 fix(cli): copy VALID_SECTIONS when parsing sections list 2026-09-13 19:04:54 +02:00
jakob.scheid 089cf5f2ff refactor(cli): move sections list parsing to function 2026-09-13 19:04:54 +02:00
jakob.scheid 8644232a00 feat: add __main__ module
Added a __main__ module that calls the CLI main function.
2026-09-13 19:04:54 +02:00
jakob.scheid 2cb99d4ca9 feat(cli): add cli module to cli package __init__ module 2026-09-13 19:04:54 +02:00
jakob.scheid 8f5dc33369 feat(cli): import languages package 2026-09-13 19:04:54 +02:00
jakob.scheid e2e6a59d13 docs(changelog): update CLI entry 2026-09-13 19:04:53 +02:00
jakob.scheid 84fe67230f test(cli): add tests for the CLI 2026-09-13 19:04:41 +02:00
jakob.scheid 348be4f07f refactor(cli): rename 'parsers' package to 'languages' 2026-09-10 15:52:05 +02:00
jakob.scheid db0d36f956 feat(cli): add __all__ to cli.cli module 2026-09-10 13:37:45 +02:00
jakob.scheid 29d1c5bced refactor(cli): move parser creation to a function 2026-09-10 13:36:06 +02:00
jakob.scheid 3ab9884be0 feat(cli): add error handling
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.
2026-09-10 13:36:03 +02:00
jakob.scheid 60a097f0cc feat(cli): allow to pass command line arguments to function 2026-09-10 09:58:18 +02:00
jakob.scheid a8513a78e2 docs(changelog): add CLI entry to changelog 2026-09-10 09:51:55 +02:00
jakob.scheid 34457f0b9f chore: add project script
Added the script 'jcloud-docsgen' to pyproject.toml so that jCloud Docsgen can
be run directly without using 'python3 -m ...'.
2026-09-10 09:50:19 +02:00
jakob.scheid bce073746e feat(cli): add Python CLI handling
Added a subparser for Python documentation and a function to generate
Python documentation.
2026-09-10 09:46:04 +02:00
jakob.scheid 350f8f9941 refactor(cli)!: make CLI a package 2026-09-05 20:38:59 +02:00
jakob.scheid 2d6de2028f feat(cli): add output directory option 2026-09-05 20:38:58 +02:00
jakob.scheid 436dacf806 feat(cli): make project_directory argument optional 2026-09-05 20:38:19 +02:00
jakob.scheid 78e3e020be fix(cli): check whether project directory exists and is a directory 2026-09-05 14:42:19 +02:00
jakob.scheid 36cedb390b refactor: update all instances of ExistingFile and ExistingDirectory in source code 2026-09-05 14:31:00 +02:00
jakob.scheid d54c0fb208 refactor: remove or update all instances of ExistingFile and ExistingDirectory in tests 2026-09-05 14:29:31 +02:00
jakob.scheid 5d8dbd659d chore(utils): mark ExistingDirectory and ExistingFile as deprecated 2026-09-05 14:24:19 +02:00
jakob.scheid 3daff2ba13 chore: add VS Code directory to gitignore 2026-09-05 13:47:11 +02:00
jakob.scheid 20fe7c5605 chore: use Gitea's python .gitignore template 2026-09-05 13:46:09 +02:00
jakob.scheid 75a13527a9 chore: add .venv to .gitignore 2026-09-05 13:37:10 +02:00
jakob.scheid c47aa0738a chore(deps): add used development dependencies 2026-09-04 19:54:46 +02:00
jakob.scheid c4212320a2 chore: Add Poetry lock 2026-09-04 19:14:10 +02:00
jakob.scheid 324ffcd4eb chore: update dependency management 2026-09-04 19:13:55 +02:00
jakob.scheid aa702ca9f9 chore: migrate manifest to Poetry 2026-09-04 19:13:32 +02:00
jakob.scheid ef5605ced1 hotfix(cd): fix job label
Release package / Publish package to package registry (release) Successful in 15s
Release package / Upload release asset (${{ fromJSON(needs.prepare_upload_release_asset.outputs.files) }}) (release) Successful in 23s
Release package / Build package (release) Successful in 24s
Release package / Prepare release asset upload (release) Successful in 14s
2026-09-03 19:42:05 +02:00
jakob.scheid eac5fb0ffc hotfix(cd): add build dependency to release asset upload preparation
Release package / Build package (release) Successful in 40s
Release package / Prepare release asset upload (release) Canceled after 0s
Release package / Upload release asset (${{ fromJSON(needs.prepare_upload_release_asset.outputs.files) }}) (release) Canceled after 0s
Release package / Publish package to package registry (release) Canceled after 0s
2026-09-03 19:14:10 +02:00
jakob.scheid 5c036e60a1 hotfix(cd): download artifact before uploading release assets
Release package / Build package (release) Successful in 24s
Release package / Publish package to package registry (release) Skipped
Release package / Prepare release asset upload (release) Successful in 14s
Release package / Upload release asset (${{ fromJSON(needs.prepare_upload_release_asset.outputs.files) }}) (release) Successful in 25s
2026-09-03 19:11:36 +02:00
jakob.scheid 9b49de336b hotfix(cd): fix workflow job label
Release package / Build package (release) Successful in 29s
Release package / Prepare release asset upload (release) Successful in 14s
Release package / Publish package to package registry (release) Skipped
Release package / Upload release asset (${{ fromJSON(needs.prepare_upload_release_asset.outputs.files) }}) (release) Failing after 21s
2026-09-03 18:07:04 +02:00
jakob.scheid 2ef362b7c0 docs(changelog): mark unreleased section as version 0.1.0 2026-09-01 16:55:44 +02:00
jakob.scheid 3428c54d99 style: ensure trailing newlines 2026-09-01 16:54:03 +02:00
jakob.scheid 3a05718612 docs(changelog): make changelog clearer
Removed internal implementation details from changelog and rephrased and reordered
some entries.
2026-09-01 16:39:42 +02:00
jakob.scheid 44de48ef9d chore: update version information to 0.1.0 2026-09-01 16:33:22 +02:00
jakob.scheid c167fcf803 feat(cd): add workflow to publish package 2026-09-01 16:19:51 +02:00