Merge pull request #2 from AG3NTZ3R0/openSourceSetUp

Open Source Project Initialization

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug Report
+about: An issue used to report a bug to help improve this project.
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+### Overview
+A clear and concise description of the bug.
+
+### Reproduction Procedure
+A series of steps to reproduce the bug.
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected Behavior
+A clear and concise description of the expected behavior.
+
+### Screenshots
+If applicable, add screenshots to help explain your problem.
+
+### Desktop Information
+ - OS: [e.g. MacOS]
+ - IDE [e.g. VSCode, PyCharm]
+ - Python Version [e.g. 3.12]
+ - Pip Version [e.g. 22]
+ - YH Finance Version [e.g. 1.0.0]
+
+### Additional Context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature Request
+about: An issue used to suggest an idea for this project.
+title: '[FEAT] '
+labels: feature
+assignees: ''
+---
+
+### Overview
+Is your feature request related to a problem? Please describe the problem.
+
+### Proposed Solution
+A clear and concise description of a solution.
+
+### Alternative Solution
+A clear and concise description of an alternative solution you've considered.
+
+### Additional Context
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+# Overview
+Please include a summary of the change and which issue is fixed alongside relevant motivation and context. Also, list any dependencies that are required for this change.
+
+## Type of Change
+Please select the options that are relevant.
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+
+## Checklist:
+- [ ] I have followed the code style of this project.
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] I have made corresponding changes to the documentation.
+- [ ] I have generated no new warnings.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] I have ensured that all tests pass locally with my changes.
+- [ ] I have installed the package locally and ensured the package functions properly.
+- [ ] I have ensured any dependent changes have been merged and published in downstream modules.
+
+## Additional Information
+
+Any additional information, configuration, or data that might be necessary to reproduce the issue or use the feature.

.github/workflows/pylint.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10"]
+        python-version: ["3.12"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -17,7 +17,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pylint
+        pip install -r requirements_dev.txt
     - name: Analysing the code with pylint
       run: |
-        pylint $(git ls-files '*.py') --fail-under=7.0
+        pylint $(git ls-files '*.py') --fail-under=8.0

.github/workflows/unittest.yml

@@ -0,0 +1,23 @@
+name: Unittest
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Run the tests with unittest
+      run: |
+        python -m unittest discover

.gitignore

@@ -0,0 +1,11 @@
+# JetBrains
+.idea
+
+# PyCache
+__pycache__
+
+# Python Development Environment
+build
+dist
+src/yh_finance.egg-info
+main.py

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing to YH Finance
+
+## Welcome!
+
+Thank you for considering contributing to YH Finance. We're thrilled you're here and want to ensure that your contribution process is as smooth and enjoyable as possible. Whether you're fixing a bug, adding a feature, or improving documentation, every contribution is valuable.
+
+## Getting Started
+
+### Step 1: Set Up Your Environment
+
+1. **Fork the repository** on GitHub.
+2. **Clone your fork** locally:
+    ```bash
+    git clone https://github.com/your-username/yh-finance.git
+    ```
+3. **Set up a virtual environment**:
+    ```bash
+    python -m venv env
+    source env/bin/activate  # On Windows use `env\Scripts\activate`
+    ```
+4. **Install the development dependencies**:
+    ```bash
+    pip install -r requirements_dev.txt
+    ```
+
+### Step 2: Make Your Changes
+
+1. Create a new branch for your changes:
+    ```bash
+    git checkout -b name-of-your-branch
+    ```
+2. Make your changes. Add tests if you're adding code, and make sure all tests pass.
+3. Install the package locally and ensure the package functions properly.
+4. Follow the coding standards and guidelines described in the next section.
+
+## Coding Standards
+
+- **Follow PEP 8** - This is the style guide for Python code. Use tools like `pylint` to check your code.
+- **Write meaningful commit messages** - Describe what your changes do and why.
+- **Include tests** - Your contributions should pass all tests. Add new tests for new features.
+
+## Pull Request Process
+
+1. **Push your changes** to your fork:
+    ```bash
+    git push origin name-of-your-branch
+    ```
+2. **Submit a pull request** through the GitHub website using your branch. Link the issue you're addressing, if applicable.
+3. **Review and address comments** - Maintainers might suggest changes. Discuss, revise, and push the necessary commits to your branch.
+4. Once approved, a project maintainer will merge your changes.
+
+## Reporting Issues
+
+Before creating a new issue, please check if it has already been reported. If you're reporting a bug, include detailed steps to reproduce, the expected outcome, and the actual outcome.
+
+## Questions?
+
+If you have any questions or need further guidance, feel free to open an issue for discussion.

SECURITY.md

@@ -0,0 +1,41 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+|---------| ------------------ |
+| 1.0.0   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Please report (suspected) security vulnerabilities to **[email protected]**. You will receive a response from us within 48 hours. After the initial reply, we will keep you informed of the progress towards a fix and full announcement, and we may ask for additional information or guidance.
+
+**Do not report security vulnerabilities through public GitHub issues.**
+
+### What to Include
+
+If possible, please include the following information in your report:
+
+- The version of our project you are using
+- What you were doing when you found the vulnerability
+- What you expected to happen
+- What actually happens
+- Steps to reproduce the vulnerability
+
+### Policy
+
+We take all security bugs in our project seriously. Thank you for improving the security of YH Finance. We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions.
+
+Update policy:
+
+- We will investigate any vulnerabilities reported to us.
+- Once confirmed, we will take the following steps:
+  - Patch the issue and release an update.
+  - Notify GitHub about the vulnerability if it affects multiple versions.
+  - Announce the update and thank the security researcher who reported it.
+
+## Security Updates
+
+This section is for you to explain how users should update their software to apply security updates you release, possibly with links to the changelog or downloads page.
+
+Thank you for supporting our project and working to improve its security.

requirements.txt

@@ -0,0 +1 @@
+requests==2.31.0

requirements_dev.txt

@@ -0,0 +1,2 @@
+requests==2.31.0
+pylint==3.0.3