fixup(readme): Align references to git repo url - #8
Open
josegomezr wants to merge 2 commits into
Open
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
Change `GIT_USER_ID/GIT_REPO_ID.git` for the proper GitHub repo URL. Additionally, removed references to root permissions for `pip install` commands. Signed-off-by: Jose D. Gomez R. <1josegomezr@gmail.com>
Copy link
Copy Markdown
Member
|
This README is generated. You'll have to update the template from openapi-generator |
Sorry, something went wrong.
Copy link
Copy Markdown
Author
|
Hm, looks like I can only remove the setup.py install line, but the placeholders can't be added via config.yaml. I could only generate a "good" readme with: uv add "openapi-generator-cli==v7.15.0"
uv run openapi-generator-cli generate \
--config config.yaml \
--template-dir templates/ \
--openapi-generator-ignore-list .openapi-generator-ignore \
--input-spec ../authentik-source/schema.yml \
--generator-name python \
--git-repo-id goauthentik \
--git-user-id client-pythonpartial diff on README.md (escaped backticks to keep formatting working) @@ -30,8 +30,9 @@ Python 3.9+
If the python package is hosted on a repository, you can install directly using:
\```sh
-pip install git+https://github.com/goauthentik/client-python.git
+pip install git+https://github.com/client-python/goauthentik.git
\```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/client-python/goauthentik.git`) |
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Change GIT_USER_ID/GIT_REPO_ID.git for the proper GitHub repo URL.
Additionally, removed references to root permissions for pip install commands.