This Github Action generates docstrings for your Python functions with the Ponicode AI engine (this action is currently in beta version)
- uses: ponicode/dogstring-action@master
with:
repo_path: ./
auth_token: ${{ secrets.PONICODE_TOKEN }}
all_repo: FalseOnce the docstrings are written, use the create pull request action to see the results in the branch of your choice
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "[ponicode-pull-request] Ponicode found docstrings to write!"
branch: ponicode-dogstring
title: "[Ponicode] Docstrings created"
body: |
Ponicode report
- Ponicode found docstrings to writeBy using this action, Ponicode will send the content of all the Python files of your project to the Ponicode API in order to provide you with relevant information. None of your code will be stored, saved or shared with a third-party.
Go to the root of your project, and create the path to your workflows directory:
mkdir -p .github/workflows
Now create a YAML file in this directory, name it ponicode.yml and copy one of the following example in it!
Here is an example of what to put in your .github/workflows/ponicode.yml file to trigger the action.
name: Ponicode DogString
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
branches: [master]
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Get paths
run: |
git show --pretty="" --name-only ${{ github.sha }} > PATHS_TO_CHANGED_FILES.txt
- uses: ponicode/docstrings-action@master
with:
repo_path: ./
auth_token: ${{ secrets.PONICODE_TOKEN }}
all_repo: True
# Creates pull request with all changes in file
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "[ponicode-pull-request] Ponicode wrote new docstrings!"
branch: ponicode-docstring
title: "[Ponicode] Docstrings created"
body: |
## ⭐️ Ponicode report ⭐️
Ponicode found **undocumented functions** in your code, and auto-generated docstrings for you.
</br>
### 🦄 We'd love to hear your feedback!🦄
Send us an email at <[email protected]>, open an issue on our Action, or join us on the [Ponicode Community Slack](https://ponicode-community.slack.com/join/shared_invite/zt-fiq4fhkg-DE~a_FkJ7xtiZxW7efyA4Q#/).
Visit **[ponicode.com](https://ponicode.com)** to find out more about what we do.
</br>
<img alt="Ponicode Logo" src="https://avatars0.githubusercontent.com/u/49948625?s=200&v=4=200zx" width="100"/>This YAML file writes docstrings on your undocumented Python functions everytime you push on master, commits them to the branch ponicode-dogstring and makes a Pull Request for you.
To get a Ponicode token follow these steps:
- Connect to your ponicode member page at https://app.ponicode.com/actions
- Copy your ponicode token
To add the Ponicode token to your github secrets follow these steps:
- Open your project on Github
- Click on
Settings - Click on
Secrets - Click on
New Secret - Name:
PONICODE_TOKEN, Value: (Paste your token from VS code)
That's it! Once this is done, the action will be triggered on every push.
| Name | Description | Required | Default |
|---|---|---|---|
repo_path |
The relative path in your repo to the files you want Ponicode to test. By default, Ponicode tests your whole repo. | true | ./ |
auth_token |
String. No default value. You need to add your authentication ponicode token at https://app.ponicode.com/actions | true | |
all_repo |
Boolean. By default, the value is False. Choose if you want to write docstrings only on the files you just commited (False) or on all your repository (True) | true | False |
enable_template |
Boolean. By default, the value is true. Choose if you want to docstrings to include params and templates | false | True |
name: Ponicode DogString
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
branches: [custom]
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Get paths
run: |
git show --pretty="" --name-only ${{ github.sha }} > PATHS_TO_CHANGED_FILES.txt
- uses: ponicode/dogstring-action@master
with:
repo_path: ./
auth_token: ${{ secrets.PONICODE_TOKEN }}
all_repo: True
# Creates pull request with all changes in file
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "[ponicode-pull-request] Ponicode wrote new docstrings!"
branch: ponicode-docstring
title: "[Ponicode] Docstrings created"
body: |
## ⭐️ Ponicode report ⭐️
Ponicode found **undocumented functions** in your code, and auto-generated docstrings for you.
</br>
### 🦄 We'd love to hear your feedback!🦄
Send us an email at <[email protected]>, open an issue on our Action, or join us on the [Ponicode Community Slack](https://ponicode-community.slack.com/join/shared_invite/zt-fiq4fhkg-DE~a_FkJ7xtiZxW7efyA4Q#/).
Visit **[ponicode.com](https://ponicode.com)** to find out more about what we do.
</br>
<img alt="Ponicode Logo" src="https://avatars0.githubusercontent.com/u/49948625?s=200&v=4=200zx" width="100"/>name: Ponicode DogString
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
branches: [master]
pull_request:
branches: [custom]
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Get paths
run: |
git show --pretty="" --name-only ${{ github.sha }} > PATHS_TO_CHANGED_FILES.txt
- uses: ponicode/dogstring-action@master
with:
repo_path: ./
auth_token: ${{ secrets.PONICODE_TOKEN }}
all_repo: True
# Creates pull request with all changes in file
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "[ponicode-pull-request] Ponicode wrote new docstrings!"
branch: ponicode-docstring
title: "[Ponicode] Docstrings created"
body: |
## ⭐️ Ponicode report ⭐️
Ponicode found **undocumented functions** in your code, and auto-generated docstrings for you.
</br>
### 🦄 We'd love to hear your feedback!🦄
Send us an email at <[email protected]>, open an issue on our Action, or join us on the [Ponicode Community Slack](https://ponicode-community.slack.com/join/shared_invite/zt-fiq4fhkg-DE~a_FkJ7xtiZxW7efyA4Q#/).
Visit **[ponicode.com](https://www.google.com)** to find out more about what we do.
</br>
<img alt="Ponicode Logo" src="https://avatars0.githubusercontent.com/u/49948625?s=200&v=4=200zx" width="100"/>Trigger Ponicode action only on your last committed files (all_repo = False) when you push on master
name: Ponicode DogString
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
branches: [master]
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Get paths
run: |
git show --pretty="" --name-only ${{ github.sha }} > PATHS_TO_CHANGED_FILES.txt
- uses: ponicode/dogstring-action@master
with:
repo_path: ./
auth_token: ${{ secrets.PONICODE_TOKEN }}
all_repo: False
# Creates pull request with all changes in file
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "[ponicode-pull-request] Ponicode wrote new docstrings!"
branch: ponicode-docstring
title: "[Ponicode] Docstrings created"
body: |
## ⭐️ Ponicode report ⭐️
Ponicode found **undocumented functions** in your code, and auto-generated docstrings for you.
</br>
### 🦄 We'd love to hear your feedback!🦄
Send us an email at <[email protected]>, open an issue on our Action, or join us on the [Ponicode Community Slack](https://ponicode-community.slack.com/join/shared_invite/zt-fiq4fhkg-DE~a_FkJ7xtiZxW7efyA4Q#/).
Visit **[ponicode.com](https://www.google.com)** to find out more about what we do.
</br>
<img alt="Ponicode Logo" src="https://avatars0.githubusercontent.com/u/49948625?s=200&v=4=200zx" width="100"/>def add(a, b):
"""
Add two arguments.
"""
return a + b
def reverse_words(input_str):
"""
Reverse string.
"""
return " ".join(input_str.split()[::-1])
def determinant(matrix):
"""
Return the determines of a matrix.
"""
if len(matrix) == 1:
return matrix[0][0]
return sum(
x * determinant(minor(matrix, 0, i)) * (-1) ** i
for i, x in enumerate(matrix[0])
)We would love to hear your feedback! Tell us what you loved and what you want us to improve about this action at [email protected], or feel free to open a Github Issue.
We also have a Slack community channel, where people can ask for help if they encounter problems with our products and where we keep you informed about our latest releases.
If you want to know more about Ponicode and the different services we propose, check out our website www.ponicode.com!
