Merge pull request 'modified: LICENSE' (#1) from dev into main
Some checks failed
Pylint / build (3.x) (push) Failing after 7s
OpenCommit Action / OpenCommit (push) Failing after 7s

Reviewed-on: #1
This commit was merged in pull request #1.
This commit is contained in:
2025-02-03 21:01:15 +01:00
5 changed files with 103 additions and 7 deletions

View File

@@ -0,0 +1,44 @@
name: 'OpenCommit Action'
on:
push:
# this list of branches is often enough,
# but you may still ignore other public branches
branches-ignore: [main master release]
jobs:
opencommit:
timeout-minutes: 10
name: OpenCommit
runs-on: ubuntu-latest
permissions: write-all
steps:
- name: Setup Node.js Environment
uses: actions/setup-node@v2
with:
node-version: '16'
- uses: actions/checkout@v4
with:
fetch-depth: 0
github-server-url: ${{ vars.GIT_SERVER_URL }}
- uses: di-sukharev/opencommit@github-action-v1.0.4
with:
GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
env:
# set openAI api key in repo actions secrets,
# for openAI keys go to: https://platform.openai.com/account/api-keys
# for repo secret go to: <your_repo_url>/settings/secrets/actions
OCO_API_KEY: ${{ secrets.AI_API_KEY }}
# customization
OCO_TOKENS_MAX_INPUT: 4096
OCO_TOKENS_MAX_OUTPUT: 500
OCO_OPENAI_BASE_PATH: ''
OCO_DESCRIPTION: false
OCO_EMOJI: true
OCO_AI_PROVIDER: ollama
OCO_API_URL: ${{ vars.OLLAMA_HOST }}
OCO_MODEL: ${{ vars.OLLAMA_MODEL }}
OCO_LANGUAGE: en
OCO_PROMPT_MODULE: conventional-commit

View File

@@ -20,7 +20,7 @@ jobs:
# https://my-ghes-server.example.com
github-server-url: ${{ vars.GIT_SERVER_URL }}
- name: Set up Python ${{ matrix.python-version }}
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}

View File

@@ -1,3 +1,8 @@
Copyright (c) 2025 Jose
Copyright (c) 2025 Jose Alvarez
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

View File

@@ -1,6 +1,35 @@
<<<<<<< HEAD
# python_template_repository
=======
# python template repository
>>>>>>> 3cfcee4 (Initial commit)
This is a template repository for Python projects. It includes basic files and directories such as `setup.py`, `requirements.txt`, and a README file.
To use this template, you can clone the repository to your local machine using the following command:
git clone https://repo.piave7.duckdns.org/Jose/python_template
Once you have cloned the repository, you can navigate into the project directory and start working on your Python project. You can install the required dependencies by running the following command:
pip install -r requirements.txt
You can also create a virtual environment for your project using the following command:
python -m venv venv
Once you have created the virtual environment, you can activate it using the appropriate command for your operating system. For example, on Windows, you can run the following command:
venv\Scripts\activate
On macOS and Linux, you can run the following command:
source venv/bin/activate
You can now start working on your Python project by editing the files in the `src` directory. Once you are done with your work, you can deactivate the virtual environment using the following command:
deactivate
To build the project, you can run the following command:
python setup.py sdist bdist_wheel
This will create a source distribution and a wheel distribution of your project.
To install the project from the source distribution, you can run the following command:
pip install dist/python_template-0.1.0.tar.gz

18
requirements.txt Normal file
View File

@@ -0,0 +1,18 @@
# requirements.txt
# Specify the package name and version
# Format: package==version
# Example packages
# numpy==1.21.2
# pandas==1.3.3
# requests==2.26.0
# flask==2.0.1
# You can also specify a range of versions
# Example:
# Django>=3.2,<4.0
# If you have a package that can be any version, just list the name
# Example:
# somepackage