bcra-connector 0.4.0__tar.gz

bcra_connector-0.4.0/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# 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, caste, color, 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 email 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
+**pablo.peitsch@gmail.com**
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

bcra_connector-0.4.0/.github/CONTRIBUTING.md

@@ -0,0 +1,131 @@
+# Contributing Guidelines
+
+*Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!* :octocat:
+
+### Contents
+
+- [Our Standards](#balance_scale-our-standards)
+- [Getting Help](#thinking-getting-help)
+- [Reporting Issues](#lady_beetle-reporting-issues)
+- [Feature Proposals](#sparkles-feature-proposals)
+- [Issue Triage](#microscope-issue-triage)
+- [Pull Requests](#rocket-pull-requests)
+- [Commit Guidelines](#pencil2-commit-guidelines)
+- [Review Process](#eyes-review-process)
+- [Code Style & Standards](#art-code-style--standards)
+- [Developer's Certificate](#scroll-developers-certificate)
+
+> **This guide sets clear expectations for everyone involved with the project so that we can improve it together while creating a welcoming space for everyone to participate.**
+
+## :balance_scale: Our Standards
+
+Please review our [Code of Conduct](CODE_OF_CONDUCT.md). It is in effect at all times. We expect it to be honored by everyone who contributes to this project. Acting like an asshole will not be tolerated.
+
+## :thinking: Getting Help
+
+Before opening an issue, check the [documentation](https://bcra-connector.readthedocs.io/). GitHub issues are for bugs and feature requests, not questions or debugging help.
+
+## :lady_beetle: Reporting Issues
+
+Before [creating an issue](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue), check if you are using the latest version of the project.
+
+### :shield: Security Issues
+
+Review our [Security Policy](SECURITY.md). **Do not** file public issues for security vulnerabilities.
+
+### :bug: Bug Reports
+
+Send detailed issue reports when you encounter bugs. A well-written bug report helps us immensely. :v:
+
+Since you are most likely a developer, **provide a ticket that you would like to receive**.
+
+- **Check the documentation** first
+- **Avoid duplicates!** Search existing issues
+- **Use reactions** instead of "+1" comments
+- **Complete the template** fully
+- **Use [GitHub-flavored Markdown](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax)**
+
+## :sparkles: Feature Proposals
+
+Feature proposals are welcome! We'll consider all requests but cannot guarantee acceptance. We aim to avoid [feature creep](https://en.wikipedia.org/wiki/Feature_creep).
+
+- **Search first** for similar proposals
+- **Complete the template** thoroughly
+- **Be specific** about implementation details
+
+## :microscope: Issue Triage
+
+Help us by reproducing bug reports and providing additional information on issues. Any assistance in resolving issues is appreciated!
+
+## :rocket: Pull Requests
+
+We **love** pull requests! Before submitting significant changes, open an issue to discuss your proposal.
+
+For accepted PRs, you'll be invited to become a project collaborator with **push access**. :tada:
+
+*All contributions are licensed under the project's license.*
+
+- **Keep it small.** One change per PR
+- **Discuss big changes** first
+- **Write clear code** over clever code
+- **Follow project style**
+- **Add tests**
+- **Update documentation**
+- **Update CHANGELOG**
+- **Target default branch**
+- **Resolve conflicts**
+- **Fix CI failures**
+
+## :pencil2: Commit Guidelines
+
+Follow these [commit message guidelines](https://chris.beams.io/posts/git-commit/):
+
+```
+[TAG] Concise change description in 50 chars or less
+
+More detailed explanation if needed. Wrap at 72 characters. Focus 
+on WHY this change is being made rather than WHAT was changed.
+
+The code itself shows what changed; use this space to explain 
+motivation and context.
+
+ - Bullet points welcome
+ - Use hyphens or asterisks
+
+Resolves: #123
+See also: #456
+```
+
+## :eyes: Review Process
+
+- **Focus on the code**, not the person
+- **Don't take it personally**
+- **Aim for quality**
+
+## :art: Code Style & Standards
+
+For Python code:
+- Follow PEP 8
+- Use type hints
+- Write clear docstrings
+- Use `black` formatter
+- Use `isort`
+- Pass `mypy` checks
+
+## :scroll: Developer's Certificate
+
+*Developer's Certificate of Origin 1.1*
+
+By contributing, you certify that:
+
+> 1. Your contribution is your original work and you have the right to submit it under the project's license
+> 2. Your contribution is based on previous work under an appropriate open source license
+> 3. The contribution was provided to you by someone who certified 1 or 2
+> 4. You understand this contribution is public and will be maintained indefinitely
+
+## The Contributor's Token :key:
+
+If you've read these guidelines (thank you!), include the ⚡ lightning emoji at the start of your pull requests and issues. You're awesome! :100:
+
+---
+*These contributing guidelines are based on the excellent work by Jesse Squires ([@jessesquires](https://github.com/jessesquires)).*

bcra_connector-0.4.0/.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,109 @@
+name: Bug Report
+description: Report an issue you encountered with BCRA Connector
+title: "[Bug]: "
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+        Please include the ⚡ emoji at the start of your title if you've read our contributing guidelines.
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Guidelines
+      description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/PPeitsch/bcra-connector/blob/main/.github/CONTRIBUTING.md)
+      options:
+        - label: I agree to follow this project's Contributing Guidelines
+          required: true
+        - label: I have searched for similar issues before creating this one
+          required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: BCRA Connector Version
+      description: What version of BCRA Connector are you using?
+      placeholder: "0.3.3"
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: Which Python version(s) have you tested with?
+      placeholder: "Python 3.9, 3.10, 3.11"
+    validations:
+      required: true
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      description: Which OS are you using?
+      placeholder: "Ubuntu 22.04, Windows 11, macOS 13.0"
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: Clearly and concisely describe the bug
+      placeholder: Tell us what went wrong
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the behavior
+      value: |
+        ```python
+        # Include a minimal code example that demonstrates the issue
+        from bcra_connector import BCRAConnector
+
+        connector = BCRAConnector()
+        ```
+
+        1. 
+        2. 
+        3. 
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened?
+    validations:
+      required: true
+
+  - type: textarea
+    id: error
+    attributes:
+      label: Error Message & Stack Trace
+      description: If applicable, paste the full error message and stack trace
+      render: python
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Add any other relevant context about the problem
+      placeholder: "Dependency versions, environment details, related issues, etc."
+    validations:
+      required: false

bcra_connector-0.4.0/.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📚 Documentation
+    url: https://bcra-connector.readthedocs.io/
+    about: Check our documentation before creating an issue
+  - name: 💬 Discussions
+    url: https://github.com/PPeitsch/bcra-connector/discussions
+    about: Please ask and answer questions here
+  - name: 🔒 Security Issues
+    url: https://github.com/PPeitsch/bcra-connector/security/policy
+    about: Please report security vulnerabilities directly to the maintainers

bcra_connector-0.4.0/.github/ISSUE_TEMPLATE/docs.yaml

@@ -0,0 +1,71 @@
+name: Documentation Issue
+description: Report issues with BCRA Connector documentation
+title: "[Docs]: "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for helping us improve our documentation!
+        Please include the ⚡ emoji at the start of your title if you've read our contributing guidelines.
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Guidelines
+      description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/PPeitsch/bcra-connector/blob/main/.github/CONTRIBUTING.md)
+      options:
+        - label: I agree to follow this project's Contributing Guidelines
+          required: true
+        - label: I have checked that this issue hasn't been reported before
+          required: true
+
+  - type: dropdown
+    id: type
+    attributes:
+      label: Issue Type
+      description: What type of documentation issue is this?
+      options:
+        - Missing documentation
+        - Incorrect documentation
+        - Unclear documentation
+        - Outdated documentation
+        - Example code issue
+        - Other
+    validations:
+      required: true
+
+  - type: input
+    id: location
+    attributes:
+      label: Documentation Location
+      description: Where is the documentation issue located?
+      placeholder: "URL, file path, or section name"
+    validations:
+      required: true
+
+  - type: textarea
+    id: current
+    attributes:
+      label: Current Documentation
+      description: What does the current documentation say?
+      placeholder: Quote the current documentation here
+    validations:
+      required: false
+
+  - type: textarea
+    id: suggested
+    attributes:
+      label: Suggested Changes
+      description: How should the documentation be improved?
+      placeholder: Describe your suggested changes or additions
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Any other context about the documentation issue?
+      placeholder: Add any other relevant information here
+    validations:
+      required: false

bcra_connector-0.4.0/.github/ISSUE_TEMPLATE/feature.yaml

@@ -0,0 +1,76 @@
+name: Feature Request
+description: Suggest a new feature or enhancement for BCRA Connector
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to suggest a new feature!
+        Please include the ⚡ emoji at the start of your title if you've read our contributing guidelines.
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Guidelines
+      description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/PPeitsch/bcra-connector/blob/main/.github/CONTRIBUTING.md)
+      options:
+        - label: I agree to follow this project's Contributing Guidelines
+          required: true
+        - label: I have searched for similar feature requests
+          required: true
+        - label: I understand that this is a request and implementation is not guaranteed
+          required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Description
+      description: Is your feature request related to a problem? Please describe.
+      placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: Describe the solution you'd like
+      placeholder: |
+        A clear and concise description of what you want to happen.
+
+        ```python
+        # Example usage of your proposed feature:
+        from bcra_connector import BCRAConnector
+
+        connector = BCRAConnector()
+        result = connector.your_new_feature()
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternative Solutions
+      description: Describe any alternative solutions you've considered
+      placeholder: What are the other approaches that could solve this?
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Any other context, examples, or references for this feature?
+      placeholder: Add any other context, code examples, or references
+    validations:
+      required: false
+
+  - type: textarea
+    id: implementation
+    attributes:
+      label: Implementation Details
+      description: If you have ideas about how to implement this feature, share them here
+      placeholder: Technical details, API design, etc.
+    validations:
+      required: false

bcra_connector-0.4.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+⚡ ⚡ *Have you read the [Contributing Guidelines](https://github.com/PPeitsch/bcra-connector/blob/main/.github/CONTRIBUTING.md)?*
+
+Fixes #
+
+## Description
+
+*Clearly and concisely describe the changes in this pull request.*
+
+## Type of Change
+
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would break existing functionality)
+- [ ] Documentation update
+- [ ] Performance improvement
+- [ ] Code style update (formatting, renaming)
+- [ ] Refactoring (no functional changes)
+- [ ] CI/CD related changes
+- [ ] Other (please describe):
+
+## Checklist
+
+- [ ] I have followed the project's coding style guidelines
+- [ ] I have added tests that prove my fix/feature works
+- [ ] All existing tests pass locally
+- [ ] I have updated the documentation accordingly
+- [ ] I have added appropriate type hints
+- [ ] I have updated the CHANGELOG.md
+- [ ] My changes generate no new warnings or errors
+- [ ] I have checked my code with `black`, `isort`, and `mypy`

bcra_connector-0.4.0/.github/SECURITY.md

@@ -0,0 +1,36 @@
+# Security Policy
+
+## Supported Versions
+
+Currently supported versions of BCRA API Connector with security updates:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.3.x   | :white_check_mark: |
+| < 0.3.0 | :x:                |
+
+## Reporting a Vulnerability
+
+We take the security of BCRA API Connector seriously. If you believe you have found a security vulnerability, please report it to us as described below.
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them via email to [pablo.peitsch@gmail.com](mailto:pablo.peitsch@gmail.com).
+
+You should receive a response within 48 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+* Full paths of source file(s) related to the manifestation of the issue
+* The location of the affected source code (tag/branch/commit or direct URL)
+* Any special configuration required to reproduce the issue
+* Step-by-step instructions to reproduce the issue
+* Proof-of-concept or exploit code (if possible)
+* Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Preferred Languages
+
+We prefer all communications to be in English, Spanish.