gemini-agent-framework 0.1.10__tar.gz → 0.1.11__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- gemini_agent_framework-0.1.11/.flake8 +7 -0
- gemini_agent_framework-0.1.11/.github/workflows/ci.yml +56 -0
- gemini_agent_framework-0.1.11/.github/workflows/docs.yml +73 -0
- gemini_agent_framework-0.1.11/.github/workflows/python-publish.yml +28 -0
- gemini_agent_framework-0.1.11/.github/workflows/tests.yml +25 -0
- gemini_agent_framework-0.1.11/.gitignore +55 -0
- gemini_agent_framework-0.1.11/CHANGELOG.md +80 -0
- gemini_agent_framework-0.1.11/CODE_OF_CONDUCT.md +126 -0
- gemini_agent_framework-0.1.11/CONTRIBUTING.md +136 -0
- gemini_agent_framework-0.1.11/LICENSE +21 -0
- gemini_agent_framework-0.1.11/PKG-INFO +165 -0
- gemini_agent_framework-0.1.11/README.md +133 -0
- gemini_agent_framework-0.1.11/docs/api_reference.md +148 -0
- gemini_agent_framework-0.1.11/docs/architecture.md +214 -0
- gemini_agent_framework-0.1.11/docs/best_practices.md +273 -0
- gemini_agent_framework-0.1.11/docs/index.md +60 -0
- gemini_agent_framework-0.1.11/docs/installation.md +101 -0
- gemini_agent_framework-0.1.11/docs/tutorials.md +207 -0
- gemini_agent_framework-0.1.11/mkdocs.yml +60 -0
- gemini_agent_framework-0.1.11/payload_variable_0.json +1 -0
- {gemini_agent_framework-0.1.10 → gemini_agent_framework-0.1.11}/pyproject.toml +72 -35
- {gemini_agent_framework-0.1.10 → gemini_agent_framework-0.1.11}/requirements.txt +1 -1
- gemini_agent_framework-0.1.11/src/gemini_agent/__init__.py +4 -0
- {gemini_agent_framework-0.1.10 → gemini_agent_framework-0.1.11}/src/gemini_agent/agent.py +594 -513
- gemini_agent_framework-0.1.11/tests/test_agent.py +142 -0
- gemini_agent_framework-0.1.10/.gitignore +0 -5
- gemini_agent_framework-0.1.10/PKG-INFO +0 -76
- gemini_agent_framework-0.1.10/README.md +0 -54
- gemini_agent_framework-0.1.10/src/gemini_agent/__init__.py +0 -4
- gemini_agent_framework-0.1.10/tests/test_agent.py +0 -76
@@ -0,0 +1,56 @@
|
|
1
|
+
name: CI
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
branches: [ main ]
|
6
|
+
pull_request:
|
7
|
+
branches: [ main ]
|
8
|
+
|
9
|
+
jobs:
|
10
|
+
test:
|
11
|
+
runs-on: ubuntu-latest
|
12
|
+
strategy:
|
13
|
+
matrix:
|
14
|
+
python-version: [3.8, 3.9, '3.10', '3.11']
|
15
|
+
|
16
|
+
steps:
|
17
|
+
- uses: actions/checkout@v3
|
18
|
+
|
19
|
+
- name: Set up Python ${{ matrix.python-version }}
|
20
|
+
uses: actions/setup-python@v4
|
21
|
+
with:
|
22
|
+
python-version: ${{ matrix.python-version }}
|
23
|
+
|
24
|
+
- name: Install dependencies
|
25
|
+
run: |
|
26
|
+
python -m pip install --upgrade pip
|
27
|
+
pip install -e ".[dev]"
|
28
|
+
|
29
|
+
|
30
|
+
build:
|
31
|
+
needs: test
|
32
|
+
runs-on: ubuntu-latest
|
33
|
+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
34
|
+
|
35
|
+
steps:
|
36
|
+
- uses: actions/checkout@v3
|
37
|
+
|
38
|
+
- name: Set up Python
|
39
|
+
uses: actions/setup-python@v4
|
40
|
+
with:
|
41
|
+
python-version: '3.11'
|
42
|
+
|
43
|
+
- name: Install build dependencies
|
44
|
+
run: |
|
45
|
+
python -m pip install --upgrade pip
|
46
|
+
pip install build
|
47
|
+
|
48
|
+
- name: Build package
|
49
|
+
run: |
|
50
|
+
python -m build
|
51
|
+
|
52
|
+
- name: Upload artifacts
|
53
|
+
uses: actions/upload-artifact@v4
|
54
|
+
with:
|
55
|
+
name: dist
|
56
|
+
path: dist/
|
@@ -0,0 +1,73 @@
|
|
1
|
+
name: Deploy Documentation
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
branches: [ main ]
|
6
|
+
workflow_dispatch:
|
7
|
+
|
8
|
+
permissions:
|
9
|
+
contents: read
|
10
|
+
pages: write
|
11
|
+
id-token: write
|
12
|
+
|
13
|
+
concurrency:
|
14
|
+
group: "pages"
|
15
|
+
cancel-in-progress: false
|
16
|
+
|
17
|
+
jobs:
|
18
|
+
build:
|
19
|
+
runs-on: ubuntu-latest
|
20
|
+
steps:
|
21
|
+
- name: Checkout
|
22
|
+
uses: actions/checkout@v3
|
23
|
+
|
24
|
+
- name: Setup Python
|
25
|
+
uses: actions/setup-python@v4
|
26
|
+
with:
|
27
|
+
python-version: '3.11'
|
28
|
+
|
29
|
+
- name: Install dependencies
|
30
|
+
run: |
|
31
|
+
python -m pip install --upgrade pip
|
32
|
+
pip install -e ".[dev]"
|
33
|
+
pip install mkdocs-material
|
34
|
+
pip install mkdocs-git-revision-date-localized-plugin
|
35
|
+
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin
|
36
|
+
pip install mkdocs-material-extensions # If you still use materialx.emoji
|
37
|
+
pip install mkdocs # Just to be sure mkdocs is installed
|
38
|
+
|
39
|
+
- name: Build documentation
|
40
|
+
run: |
|
41
|
+
# Remove any existing site directory
|
42
|
+
rm -rf site/
|
43
|
+
|
44
|
+
# Build the documentation
|
45
|
+
mkdocs build
|
46
|
+
|
47
|
+
# Check if build was successful
|
48
|
+
if [ ! -d "site" ]; then
|
49
|
+
echo "Error: mkdocs build failed - site directory was not created"
|
50
|
+
exit 1
|
51
|
+
fi
|
52
|
+
|
53
|
+
# List contents for debugging
|
54
|
+
echo "Contents of current directory:"
|
55
|
+
ls -la
|
56
|
+
echo "Contents of site directory:"
|
57
|
+
ls -la site/
|
58
|
+
|
59
|
+
- name: Upload artifact
|
60
|
+
uses: actions/upload-pages-artifact@v3
|
61
|
+
with:
|
62
|
+
path: ./site
|
63
|
+
|
64
|
+
deploy:
|
65
|
+
environment:
|
66
|
+
name: github-pages
|
67
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
68
|
+
runs-on: ubuntu-latest
|
69
|
+
needs: build
|
70
|
+
steps:
|
71
|
+
- name: Deploy to GitHub Pages
|
72
|
+
id: deployment
|
73
|
+
uses: actions/deploy-pages@v4
|
@@ -0,0 +1,28 @@
|
|
1
|
+
name: Publish to PyPI
|
2
|
+
|
3
|
+
on:
|
4
|
+
release:
|
5
|
+
types: [published]
|
6
|
+
|
7
|
+
jobs:
|
8
|
+
deploy:
|
9
|
+
runs-on: ubuntu-latest
|
10
|
+
steps:
|
11
|
+
- uses: actions/checkout@v3
|
12
|
+
- name: Set up Python
|
13
|
+
uses: actions/setup-python@v4
|
14
|
+
with:
|
15
|
+
python-version: '3.8'
|
16
|
+
- name: Install dependencies
|
17
|
+
run: |
|
18
|
+
python -m pip install --upgrade pip
|
19
|
+
pip install build
|
20
|
+
- name: Build package
|
21
|
+
run: python -m build
|
22
|
+
- name: Publish package
|
23
|
+
env:
|
24
|
+
TWINE_USERNAME: __token__
|
25
|
+
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
|
26
|
+
run: |
|
27
|
+
pip install twine
|
28
|
+
twine upload dist/*
|
@@ -0,0 +1,25 @@
|
|
1
|
+
name: Tests
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
branches: [ main ]
|
6
|
+
pull_request:
|
7
|
+
branches: [ main ]
|
8
|
+
|
9
|
+
jobs:
|
10
|
+
test:
|
11
|
+
runs-on: ubuntu-latest
|
12
|
+
strategy:
|
13
|
+
matrix:
|
14
|
+
python-version: [3.8, 3.9, '3.10', '3.11']
|
15
|
+
|
16
|
+
steps:
|
17
|
+
- uses: actions/checkout@v3
|
18
|
+
- name: Set up Python ${{ matrix.python-version }}
|
19
|
+
uses: actions/setup-python@v4
|
20
|
+
with:
|
21
|
+
python-version: ${{ matrix.python-version }}
|
22
|
+
- name: Install dependencies
|
23
|
+
run: |
|
24
|
+
python -m pip install --upgrade pip
|
25
|
+
pip install -e ".[dev]"
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# Python
|
2
|
+
__pycache__/
|
3
|
+
*.py[cod]
|
4
|
+
*$py.class
|
5
|
+
*.so
|
6
|
+
.Python
|
7
|
+
build/
|
8
|
+
develop-eggs/
|
9
|
+
dist/
|
10
|
+
downloads/
|
11
|
+
eggs/
|
12
|
+
.eggs/
|
13
|
+
lib/
|
14
|
+
lib64/
|
15
|
+
parts/
|
16
|
+
sdist/
|
17
|
+
var/
|
18
|
+
wheels/
|
19
|
+
*.egg-info/
|
20
|
+
.installed.cfg
|
21
|
+
*.egg
|
22
|
+
|
23
|
+
# Virtual Environment
|
24
|
+
venv/
|
25
|
+
env/
|
26
|
+
ENV/
|
27
|
+
|
28
|
+
# IDE
|
29
|
+
.idea/
|
30
|
+
.vscode/
|
31
|
+
*.swp
|
32
|
+
*.swo
|
33
|
+
|
34
|
+
# Environment variables
|
35
|
+
.env
|
36
|
+
.env.local
|
37
|
+
|
38
|
+
# Logs
|
39
|
+
*.log
|
40
|
+
|
41
|
+
# Coverage
|
42
|
+
.coverage
|
43
|
+
htmlcov/
|
44
|
+
|
45
|
+
# Distribution
|
46
|
+
dist/
|
47
|
+
build/
|
48
|
+
|
49
|
+
# Jupyter Notebook
|
50
|
+
.ipynb_checkpoints
|
51
|
+
|
52
|
+
# Testing
|
53
|
+
.pytest_cache/
|
54
|
+
.coverage
|
55
|
+
htmlcov/
|
@@ -0,0 +1,80 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
All notable changes to this project will be documented in this file.
|
4
|
+
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
7
|
+
|
8
|
+
## [Unreleased]
|
9
|
+
|
10
|
+
### Added
|
11
|
+
- Initial release of Gemini Agent Framework
|
12
|
+
- Basic agent functionality with tool support
|
13
|
+
- Variable management system
|
14
|
+
- Type conversion and validation
|
15
|
+
- Error handling and recovery
|
16
|
+
- Documentation and examples
|
17
|
+
|
18
|
+
### Changed
|
19
|
+
- None
|
20
|
+
|
21
|
+
### Deprecated
|
22
|
+
- None
|
23
|
+
|
24
|
+
### Removed
|
25
|
+
- None
|
26
|
+
|
27
|
+
### Fixed
|
28
|
+
- None
|
29
|
+
|
30
|
+
### Security
|
31
|
+
- None
|
32
|
+
|
33
|
+
## [0.1.0] - 2024-03-20
|
34
|
+
|
35
|
+
### Added
|
36
|
+
- Initial release
|
37
|
+
- Basic agent functionality
|
38
|
+
- Tool system with decorators
|
39
|
+
- Variable management
|
40
|
+
- Type system
|
41
|
+
- Error handling
|
42
|
+
- Basic documentation
|
43
|
+
|
44
|
+
### Changed
|
45
|
+
- None
|
46
|
+
|
47
|
+
### Deprecated
|
48
|
+
- None
|
49
|
+
|
50
|
+
### Removed
|
51
|
+
- None
|
52
|
+
|
53
|
+
### Fixed
|
54
|
+
- None
|
55
|
+
|
56
|
+
### Security
|
57
|
+
- None
|
58
|
+
|
59
|
+
## [0.0.1] - 2024-03-19
|
60
|
+
|
61
|
+
### Added
|
62
|
+
- Project setup
|
63
|
+
- Basic structure
|
64
|
+
- Initial documentation
|
65
|
+
- Development environment
|
66
|
+
|
67
|
+
### Changed
|
68
|
+
- None
|
69
|
+
|
70
|
+
### Deprecated
|
71
|
+
- None
|
72
|
+
|
73
|
+
### Removed
|
74
|
+
- None
|
75
|
+
|
76
|
+
### Fixed
|
77
|
+
- None
|
78
|
+
|
79
|
+
### Security
|
80
|
+
- None
|
@@ -0,0 +1,126 @@
|
|
1
|
+
# Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity
|
10
|
+
and orientation.
|
11
|
+
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
13
|
+
diverse, inclusive, and healthy community.
|
14
|
+
|
15
|
+
## Our Standards
|
16
|
+
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
18
|
+
community include:
|
19
|
+
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
24
|
+
and learning from the experience
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the
|
26
|
+
overall community
|
27
|
+
|
28
|
+
Examples of unacceptable behavior include:
|
29
|
+
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or
|
31
|
+
advances of any kind
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
33
|
+
* Public or private harassment
|
34
|
+
* Publishing others' private information, such as a physical or email
|
35
|
+
address, without their explicit permission
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
37
|
+
professional setting
|
38
|
+
|
39
|
+
## Enforcement Responsibilities
|
40
|
+
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
44
|
+
or harmful.
|
45
|
+
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
49
|
+
decisions when appropriate.
|
50
|
+
|
51
|
+
## Scope
|
52
|
+
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
54
|
+
an individual is officially representing the community in public spaces.
|
55
|
+
|
56
|
+
## Enforcement
|
57
|
+
|
58
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
59
|
+
reported to the community leaders responsible for enforcement at
|
60
|
+
[mohamed.baathman2001@gmail.com]. All complaints will be reviewed and investigated
|
61
|
+
promptly and fairly.
|
62
|
+
|
63
|
+
All community leaders are obligated to respect the privacy and security of the
|
64
|
+
reporter of any incident.
|
65
|
+
|
66
|
+
## Enforcement Guidelines
|
67
|
+
|
68
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
69
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
70
|
+
|
71
|
+
### 1. Correction
|
72
|
+
|
73
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
74
|
+
unprofessional or unwelcome in the community.
|
75
|
+
|
76
|
+
**Consequence**: A private, written warning from community leaders, providing
|
77
|
+
clarity around the nature of the violation and an explanation of why the
|
78
|
+
behavior was inappropriate. A public apology may be requested.
|
79
|
+
|
80
|
+
### 2. Warning
|
81
|
+
|
82
|
+
**Community Impact**: A violation through a single incident or series of
|
83
|
+
actions.
|
84
|
+
|
85
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
86
|
+
interaction with the people involved, including unsolicited interaction with
|
87
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
88
|
+
includes avoiding interactions in community spaces as well as external channels
|
89
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
90
|
+
ban.
|
91
|
+
|
92
|
+
### 3. Temporary Ban
|
93
|
+
|
94
|
+
**Community Impact**: A serious violation of community standards, including
|
95
|
+
sustained inappropriate behavior.
|
96
|
+
|
97
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
98
|
+
communication with the community for a specified period of time. No public or
|
99
|
+
private interaction with the people involved, including unsolicited interaction
|
100
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
101
|
+
Violating these terms may lead to a permanent ban.
|
102
|
+
|
103
|
+
### 4. Permanent Ban
|
104
|
+
|
105
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
106
|
+
standards, including sustained inappropriate behavior, harassment of an
|
107
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
108
|
+
|
109
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
110
|
+
community.
|
111
|
+
|
112
|
+
## Attribution
|
113
|
+
|
114
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
115
|
+
version 2.0, available at
|
116
|
+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
117
|
+
|
118
|
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
119
|
+
enforcement ladder][Mozilla CoC].
|
120
|
+
|
121
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
122
|
+
https://www.contributor-covenant.org/faq. Translations are available at
|
123
|
+
https://www.contributor-covenant.org/translations.
|
124
|
+
|
125
|
+
[homepage]: https://www.contributor-covenant.org
|
126
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
@@ -0,0 +1,136 @@
|
|
1
|
+
# Contributing to Gemini Agent Framework
|
2
|
+
|
3
|
+
Thank you for your interest in contributing to the Gemini Agent Framework! This document provides guidelines and instructions for contributing.
|
4
|
+
|
5
|
+
## Code of Conduct
|
6
|
+
|
7
|
+
By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.
|
8
|
+
|
9
|
+
## How to Contribute
|
10
|
+
|
11
|
+
### 1. Reporting Bugs
|
12
|
+
|
13
|
+
If you find a bug, please create an issue with:
|
14
|
+
- A clear, descriptive title
|
15
|
+
- Steps to reproduce the bug
|
16
|
+
- Expected behavior
|
17
|
+
- Actual behavior
|
18
|
+
- Environment details (OS, Python version, etc.)
|
19
|
+
- Any relevant logs or error messages
|
20
|
+
|
21
|
+
### 2. Suggesting Features
|
22
|
+
|
23
|
+
We welcome feature suggestions! Please create an issue with:
|
24
|
+
- A clear, descriptive title
|
25
|
+
- Detailed description of the feature
|
26
|
+
- Use cases and examples
|
27
|
+
- Any relevant implementation ideas
|
28
|
+
|
29
|
+
### 3. Pull Requests
|
30
|
+
|
31
|
+
1. Fork the repository
|
32
|
+
2. Create a new branch for your changes
|
33
|
+
3. Make your changes
|
34
|
+
4. Add tests for your changes
|
35
|
+
5. Update documentation
|
36
|
+
6. Submit a pull request
|
37
|
+
|
38
|
+
### 4. Development Setup
|
39
|
+
|
40
|
+
1. Clone the repository:
|
41
|
+
```bash
|
42
|
+
git clone https://github.com/m7mdony/gemini-agent-framework.git
|
43
|
+
cd gemini-agent-framework
|
44
|
+
```
|
45
|
+
|
46
|
+
2. Create a virtual environment:
|
47
|
+
```bash
|
48
|
+
python -m venv venv
|
49
|
+
source venv/bin/activate # On Windows: venv\Scripts\activate
|
50
|
+
```
|
51
|
+
|
52
|
+
3. Install development dependencies:
|
53
|
+
```bash
|
54
|
+
pip install -e ".[dev]"
|
55
|
+
```
|
56
|
+
|
57
|
+
4. Run tests:
|
58
|
+
```bash
|
59
|
+
pytest
|
60
|
+
```
|
61
|
+
|
62
|
+
### 5. Code Style
|
63
|
+
|
64
|
+
- Follow PEP 8 guidelines
|
65
|
+
- Use type hints
|
66
|
+
- Write docstrings for all functions and classes
|
67
|
+
- Keep lines under 100 characters
|
68
|
+
- Use meaningful variable names
|
69
|
+
|
70
|
+
### 6. Testing
|
71
|
+
|
72
|
+
- Write unit tests for new features
|
73
|
+
- Ensure all tests pass
|
74
|
+
- Maintain or improve test coverage
|
75
|
+
- Test edge cases and error conditions
|
76
|
+
|
77
|
+
### 7. Documentation
|
78
|
+
|
79
|
+
- Update README.md if needed
|
80
|
+
- Add docstrings to new functions/classes
|
81
|
+
- Update API documentation
|
82
|
+
- Add examples for new features
|
83
|
+
|
84
|
+
## Pull Request Process
|
85
|
+
|
86
|
+
1. Update the README.md with details of changes if needed
|
87
|
+
2. Update the documentation with any new features
|
88
|
+
3. Add tests for new functionality
|
89
|
+
4. Ensure all tests pass
|
90
|
+
5. Update the version number in pyproject.toml
|
91
|
+
6. The PR will be merged once it has been reviewed and approved
|
92
|
+
|
93
|
+
## Development Workflow
|
94
|
+
|
95
|
+
1. Create a new branch for your feature/fix
|
96
|
+
2. Make your changes
|
97
|
+
3. Run tests locally
|
98
|
+
4. Update documentation
|
99
|
+
5. Submit PR
|
100
|
+
6. Address review comments
|
101
|
+
7. PR gets merged
|
102
|
+
|
103
|
+
## Commit Messages
|
104
|
+
|
105
|
+
Follow these guidelines for commit messages:
|
106
|
+
- Use present tense ("Add feature" not "Added feature")
|
107
|
+
- Use imperative mood ("Move cursor to..." not "Moves cursor to...")
|
108
|
+
- Limit the first line to 72 characters or less
|
109
|
+
- Reference issues and pull requests liberally
|
110
|
+
|
111
|
+
## Review Process
|
112
|
+
|
113
|
+
1. All PRs require at least one review
|
114
|
+
2. PRs must pass all tests
|
115
|
+
3. Documentation must be updated
|
116
|
+
4. Code must follow style guidelines
|
117
|
+
5. Changes must be well-tested
|
118
|
+
|
119
|
+
## Release Process
|
120
|
+
|
121
|
+
1. Update version number
|
122
|
+
2. Update changelog
|
123
|
+
3. Create release notes
|
124
|
+
4. Tag the release
|
125
|
+
5. Build and publish to PyPI
|
126
|
+
|
127
|
+
## Getting Help
|
128
|
+
|
129
|
+
- Create an issue for bugs or feature requests
|
130
|
+
- Join our Discord community
|
131
|
+
- Check the documentation
|
132
|
+
- Ask in discussions
|
133
|
+
|
134
|
+
## License
|
135
|
+
|
136
|
+
By contributing, you agree that your contributions will be licensed under the project's MIT License.
|
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2024 Mohamed Baathman
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|