-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DEID-1311-update-git-pre-commit-hook-documentation #4
DEID-1311-update-git-pre-commit-hook-documentation #4
Conversation
ketakipai
commented
Nov 29, 2022
- Updated README according to specifications
- The sample repo is https://github.com/privateai/pai-pre-commit-demo
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: This integration only works with the 3.0 version of Private AI's container
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made a couple of small suggestions (and you'll need to make sure that it all looks OK) but apart from that LGTM
* 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