DEID-1311-update-git-pre-commit-hook-documentation #4
Conversation
This file contains 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
Contributor
ketakipai
commented
Nov 29, 2022
ketakipai
commented
- Updated README according to specifications
- The sample repo is https://github.com/privateai/pai-pre-commit-demo
ketakipai
changed the title
README.md
Outdated
| ``` | ||
| 4. Run 'pre-commit install' from inside the git repo where you want to use this hook. | ||
| 5. Replace 'URL' with the url of where your container is hosted.\ | ||
| eg. http://localhost:8080/v3/process_text |
There was a problem hiding this comment.
Suggested change
| eg. http://localhost:8080/v3/process_text | |
| eg. http://localhost:8080/v3/process_text for a container running locally or https://api.private-ai.com/deid/v3/process_text for Private AI's cloud endpoint. |
|
|
||
| 1. Run 'pre-commit install' from inside the git repo where you want to use this hook. | ||
| 2. Create a file called '.pre-commit-config.yaml' and add the following code to it: | ||
| ## Installation |
There was a problem hiding this comment.
Prerequisites
This integration requires an endpoint to make requests against. For instructions, please see the installation guide.
|
|
||
| <pre> |
There was a problem hiding this comment.
Note: This integration only works with the 3.0 version of Private AI's container
yaysummeriscoming
approved these changes
Nov 29, 2022
ketakipai
deleted the
DEID-1311-update-git-pre-commit-hook-documentation
branch
ketakipai
added a commit
that referenced
this pull request
Dec 6, 2022
* added all files * updated README * Deid 1284 improve robustness of pii check on off flags (#3) * fixed bugs with the PII_CHECK flags * removed local hook * added suggestion by Guy * added Guys suggestion and removed local hook * DEID-1311-update-git-pre-commit-hook-documentation (#4) * updated README * did the suggested changes * Update the way API KEY is read (#2) * passing path of env file as variable * remove the unnecessary line from setup.py * bug fix and updated script to get api key from env file * updated README * removed pathlib2 dependency and added stuff to check for relative path * updated README * added validation to check if API_KEY is missing * updated README * added all dependencies in setup.py, removed from config * removing unnecessary dependecies from pre-commit-hooks * updated dependencies * removed unnecessary fields mentioned in README, tested and confirmed that we need the rest * updated README * updated README * updated README * updated pre-commit-hooks * removing args from pre-commit-hooks * removing entry from pre-commit-config * updated README to resolve conflicts * Make compatible with beta2 (#5) * test * updated fields to be compatible with beta 2 * removing line added for debugging * updated README to contain latest rev * update README to have new repo * added link_batch and removed an unused function (#6) * added link_batch and removed an unused function * removed test file
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.