Merge remote-tracking branch 'upstream/master'

Author: CSWorldTelugu

.github/workflows/workflow.yml

@@ -15,53 +15,68 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout master branch
-      uses: actions/checkout@v4
-      with:
-        ref: master
-        fetch-depth: 0
+      - name: Checkout master branch
+        uses: actions/checkout@v4
+        with:
+          ref: master
+          fetch-depth: 0
 
-    - name: Create and push to main
-      run: |
-        git checkout -b main
-        git push origin main
+      # - name: Create and push to main
+      #   run: |
+      #     git checkout -b main
+      #     git push origin main
 
-    - name: Checkout release branch
-      run: git checkout main
+      - name: Create and push to feature branch
+        run: |
+          git checkout -b release-main
+          git push origin release-main
 
-    - name: Set up Python
-      uses: actions/setup-python@v3
-      with:
-        python-version: '3.x'
+      - name: Raise PR from release-main to main
+        uses: peter-evans/create-pull-request@v5
+        with:
+          base: main
+          head: release-main
+          title: "Automated Release PR: release-main -> main"
+          body: "This PR contains the automated changes for the release process."
+          branch: pr-release-main-to-main
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build twine python-semantic-release setuptools-scm
+      - name: Checkout release branch
+        # run: git checkout main
+        run: git checkout release-main
 
-    - name: Run semantic-release
-      env:
-        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: |
-        git config user.name github-actions
-        git config user.email github-actions@github.com
-        semantic-release version
-        semantic-release publish
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.x"
 
-    - name: Build package
-      run: python -m build
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine python-semantic-release setuptools-scm
 
-    - name: Publish package to PyPI
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
-      run: twine upload dist/*
+      - name: Run semantic-release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          semantic-release version
+          semantic-release publish
 
-    - name: Raise PR from main to master
-      uses: peter-evans/create-pull-request@v5
-      with:
-        base: master
-        head: main
-        title: 'Release PR: main -> master'
-        body: 'This PR merges the changes from the main branch back into master after the release.'
-        branch: pr-main-to-master
+      - name: Build package
+        run: python -m build
+
+      - name: Publish package to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: twine upload dist/*
+
+      - name: Raise PR from main to master
+        uses: peter-evans/create-pull-request@v5
+        with:
+          base: master
+          head: main
+          title: "Release PR: main -> master"
+          body: "This PR merges the changes from the main branch back into master after the release."
+          branch: pr-main-to-master

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black
+
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+        require_serial: true
+        args: [
+            "-rn", # Only display messages
+            "-sn", # Don't display the score
+          ]
+        files: ^app/.*\.py$

.releaserc

@@ -0,0 +1,13 @@
+{
+  "branches": [
+    "release-main"
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/github",
+    "@semantic-release/git",
+    "@semantic-release/pypi"
+  ]
+}

CHANGELOG.md

@@ -0,0 +1,53 @@
+
+# Changelog
+
+All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- [List new features or enhancements added but not yet released]
+
+### Changed
+
+- [List changes, improvements, or modifications made but not yet released]
+
+### Fixed
+
+- [List bug fixes or corrections made but not yet released]
+
+## [Version] - YYYY-MM-DD
+
+### Added
+
+- [List new features or enhancements added in this version]
+
+### Changed
+
+- [List changes, improvements, or modifications made in this version]
+
+### Fixed
+
+- [List bug fixes or corrections made in this version]
+
+## [Older Versions]
+
+[Repeat the above sections for older versions of your project]
+
+## Contributing
+
+Please read [CONTRIBUTING.md](./contributing-template.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Authors
+
+- Author 1
+- Author 2
+
+## License
+
+This project is licensed under the [License Name] - see the [LICENSE.md](./license-template.md) file for details.
+
+## Customization
+
+You can customize this changelog to meet the specific needs and preferences of your project. Feel free to modify the structure, add more details, or change the formatting to better suit your project's versioning and documentation requirements.

CONTRIBUTING.md

@@ -1,21 +1,15 @@
 # Contributing to Python FM DAPI Weaver
 
-
 Thank you for your interest in contributing to **Python FM DAPI Weaver**! This guide outlines the steps to get started and the standards we follow.
 
-
-
-##  Ways to  Contribute?
+## Ways to Contribute?
 
 You can help improve the project in the following ways:
 
 - **Bug Reports**: Identify and report any bugs you find.
 - **Feature Proposals**: Suggest new features or improvements to existing ones.
 - **Documentation**: Improve or expand documentation to make it easier for users and developers.
 - **Fixing Issues**: Address open issues and contribute fixes.
- 
-
- 
 
 ## Contribution Guidelines
 
@@ -24,28 +18,16 @@ You can help improve the project in the following ways:
 - Ensure your changes don’t break existing functionality (run tests if available).
 - Make small, focused commits with clear messages.
 
-
-
-
 ## A Quick Start Guide:
 
-
 ### 1. Fork the Repository
 
-
-
 Click the **Fork** button at the top-right corner of this repository to create your own copy.
 
-
-
 ### 2. Clone Your Fork
 
-
-
 Clone the repository to your local machine:
 
-
-
 ```
 git clone https://github.com/your-username/python-fm-dapi-weaver.git
 cd python-fm-dapi-weaver
@@ -54,83 +36,59 @@ cd python-fm-dapi-weaver
 
 ### 3. Install Dependencies
 
-
-
 It's recommended to use a virtual environment:
 
-
-
 ```
 python -m venv venv
 source venv/bin/activate  # On Windows use `venv\Scripts\activate`
 pip install -r requirements.txt
- 
+
 
 ```
 
 ### 4. Run the Server
 
-
 you can run the server using below command:
 
-
-
 ```
 python -m  python_fm_dapi_weaver.main
- 
+
 ```
 
 ### 5. Test the API
 
-
-
 Once the server is running, you can test the API using tools like [Postman](https://www.postman.com/). The server should be accessible at `http://127.0.0.1:8000`.
 
-
 ### 6. Make Changes
 
 Feel free to make changes or add new features! You can modify the code in the `python_fm_dapi_weaver` directory and test locally to ensure your changes work as expected.
 
-
 For example, to add a new feature, you might:
+
 - Create a new module or file in the `python_fm_dapi_weaver` folder.
 - Modify existing files if you're improving or fixing existing functionality.
 - Ensure your changes align with the overall structure and coding style of the project.
 
- 
+### 7. **Commit the Changes:**
 
-### 7. **Commit the Changes:** 
 Commit your work with a concise, clear message about what was modified.
 
+### 8. **Push to Your Fork on GitHub:**
 
-
-### 8. **Push to Your Fork on GitHub:** 
 Push the branch/changes to your GitHub Repository.
 
-
-
-### 9. **Submitting changes:** 
+### 9. **Submitting changes:**
 
 Please open a Pull Request with a list of what you've done.Make sure, if possible, keep all of your commits are atomic (one feature per commit).
 
-
 ## Code of Conduct and Licensing
 
-By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md) and are licensed under the project's [License](./LICENSE). 
-
-
+By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md) and are licensed under the project's [License](./LICENSE).
 
 # Thank You for Contributing!
 
-
-
 Your contributions are what make this project great! We appreciate the time, effort, and ideas you put into helping us improve.
 
-
-
 If you have any questions, feel free to reach out. We encourage everyone to contribute, no matter how big or small. Together, we can make this project even better!
 
-
-
 Happy coding!!
- 

Pipfile

@@ -7,6 +7,7 @@ name = "pypi"
 fastapi = "*"
 uvicorn = "*"
 requests = "*"
+python-multipart = "*"
 
 [dev-packages]