Merge branch 'main' into 274-add-azure-blob-storage-state-serializer-and-deserializer-for-stateless-run-with-statefull-support

Author: MDUYN

.github/workflows/test.yml

@@ -41,7 +41,10 @@ jobs:
       fail-fast: true
       matrix:
         os: [ "ubuntu-latest", "macos-latest" ]
-        python-version: [ "3.8", "3.9", "3.10", "3.11" ]
+        python-version: [ "3.10", "3.11" ]
+    defaults:
+      run:
+        shell: bash
     runs-on: ${{ matrix.os }}
     steps:
       #----------------------------------------------
@@ -99,7 +102,7 @@ jobs:
       #----------------------------------------------
       - name: Run tests
         run: |
-          source .venv/bin/activate
+          source $VENV
           coverage run -m unittest discover -s tests
 #      #----------------------------------------------
 #      #             upload coverage stats

README.md

@@ -1 +1 @@
-__version__='v3.8.1'
+__version__='v6.1.1'

__init__.py

@@ -0,0 +1,37 @@
+# Contributing to Investing Algorithm Framework
+
+Thank you for considering contributing to the Investing Algorithm Framework! We welcome contributions from the community to make this project better.
+
+Before contributing, please read the [STYLE_GUIDE.md](STYLE_GUIDE.md) to understand the coding style and conventions used in this project. Also, make sure to reach out
+to the maintainers in the [Discussions]() or [Issues]() if you have any questions or need help. Also, if you would like to add a new feature or fix a bug, please create first an issue or start a discussion to discuss it with the maintainers.
+
+## How to Contribute
+
+1. **Fork the Repository**: Click the `Fork` button in the top-right corner of the repo.
+2. **Clone Your Fork**:
+
+    ```bash
+    git clone https://github.com/your-username/your-project.git
+    cd your-project
+    ```
+
+3. Set Up the Environment: Follow the steps in the README.md to set up dependencies and the local environment.
+4. Propose your feature or bugfix in the [issues](https://github.com/coding-kitties/investing-algorithm-framework/issues) or in a [discussion](https://github.com/coding-kitties/investing-algorithm-framework/discussions).
+5. Make Changes:
+   * Work on your feature or bugfix in a separate branch.
+   * Use a meaningful branch name like fix-issue-123 or feature-new-module.
+6. Run Tests: Run the tests to ensure your changes don't break anything:
+
+    ```bash
+    python -m unittest discover -s tests
+    ```
+
+7. Run Linting and make sure your code follows the [style guide](https://github.com/coding-kitties/investing-algorithm-framework):
+
+    ```bash
+    flake8 investing_algorithm_framework
+    ```
+
+8. Create a Pull Request inline with the [Pull Request Template]().
+9. Wait for the maintainers to review your PR. Make changes if requested.
+10. Once your PR is approved, it will be merged into the main branch.

docs/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+---
+name: Bug Report
+about: Report a bug in the project
+title: "[Bug]: Brief description"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the Bug**
+A clear and concise description of what the bug is.
+
+**Steps to Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Run '...'
+3. See error
+
+**Expected Behavior**
+What you expected to happen.
+
+**Screenshots (if applicable)**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+- OS: [e.g., macOS 12.3, Windows 11]
+- Python version: [e.g., 3.9.1]
+- Package version: [e.g., 0.1.0]
+
+**Additional Context**
+Add any other context about the problem here.

docs/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest a new feature or improvement
+title: "[Feature]: Brief description"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem?**
+A clear and concise description of the problem. Example: "I find it difficult to ..."
+
+**Describe the Solution You'd Like**
+What you want the feature to do.
+
+**Describe Alternatives You've Considered**
+Any alternative solutions or features you've considered.
+
+**Additional Context**
+Add any other context or screenshots about the feature request here.

docs/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+# Pull Request Title: [Brief Description]
+
+## Description
+
+A clear and concise description of the changes made. Include:
+- What issue or feature this PR addresses.
+- Why these changes are necessary.
+
+Fixes #[issue-number] (if applicable).
+
+## Type of Change
+- [ ] Bugfix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Refactor/optimization
+
+## Checklist
+- [ ] Code is formatted with `black` or a similar linter.
+- [ ] Tests have been added or updated.
+- [ ] Documentation has been updated (if needed).
+
+## Additional Notes
+Include any additional notes or context here.