Initial

.deepsource.toml

@@ -0,0 +1,9 @@
+version = 1
+
+test_patterns = ["tests/**"]
+
+[[analyzers]]
+name = "python"
+
+  [analyzers.meta]
+  runtime_version = "3.x.x"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+Please provide a clear and concise description of what the bug is. 
+**Important: please make sure you remove your API key from the code, if it is there.**
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Windows 11, Ubuntu 24, etc.]
+ - ParityVend Library 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,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? If yes, please describe.**
+A clear and concise description of your feature suggestion. 
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -0,0 +1,16 @@
+install_deps.bat
+env.bat
+run_tests.bat
+run_tests38.bat
+run_tests39.bat
+run_tests310.bat
+run_tests311.bat
+run_tests312.bat
+run_tests313.bat
+run_testspypy.bat
+
+__pycache__/
+*.py[cod]
+
+.pytest_cache
+.vscode

CHANGELOG.MD

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2024-03-15
+
+### Added
+
+- Initial release of the library.
+- Implemented core functionality for all backend endpoints of the ParityVend API.
+
+### Changed
+
+- N/A (Initial release)
+
+### Deprecated
+
+- N/A (Initial release)
+
+### Removed
+
+- N/A (Initial release)
+
+### Fixed
+
+- N/A (Initial release)
+
+### Security
+
+- N/A (Initial release)

CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+
+# 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 via email address, "help AT ambeteco DOT 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

CONTRIBUTING.md

@@ -0,0 +1,113 @@
+# Contributing to ParityVend Python API
+
+Thank you for considering contributing to the ParityVend Python API! We value your time and efforts to help us improve and grow. This document will guide you through the contribution process. Whether it's a bug fix, new feature, or documentation improvement, your help is invaluable in making this project better.
+
+## Code of Conduct
+
+Before contributing, please ensure you have read and understood our [Code of Conduct](https://github.com/ParityVend/parityvend_api_python/blob/main/CODE_OF_CONDUCT.md). We are committed to providing a welcoming and inclusive experience for everyone.
+
+## Getting Help
+
+If you have any questions, need assistance, or want to discuss ideas for improvements, feel free to reach out to us at "help AT ambeteco DOT com". We strive to respond promptly and provide helpful guidance.
+
+## Development Setup
+
+To get started with development, make sure you have the following prerequisites installed:
+
+- Python (version 3.8 or higher)
+- Pip (Python package installer)
+
+### Step 1: Clone the Repository
+
+First, clone the repository to your local machine:
+
+```sh
+git clone https://github.com/ParityVend/parityvend_api_python.git
+cd python_api
+```
+
+### Step 2: Set up a Virtual Environment (Optional but Recommended)
+
+It's a good practice to create a virtual environment to isolate project dependencies and avoid conflicts with other Python projects on your system. You can use the built-in `venv` module or a tool like `virtualenv`.
+
+#### Using `venv`
+
+```sh
+python3 -m venv env
+source env/bin/activate  # On Windows, use `env\Scripts\activate`
+```
+
+#### Using `virtualenv`
+
+```sh
+pip install virtualenv
+virtualenv env
+source env/bin/activate  # On Windows, use `env\Scripts\activate`
+```
+
+### Step 3: Install Dependencies
+
+With the virtual environment activated (if you chose to use one), install the project dependencies:
+
+```sh
+pip install -r requirements.txt
+pip install -r requirements_dev.txt
+```
+
+### Step 4: Run Tests
+
+Before making any changes, ensure that the existing tests pass on your system:
+
+```sh
+pytest -rP tests
+```
+
+**Note:** To run the tests successfully, you will need to obtain a valid ParityVend API key and set the following environment variables:
+
+- `parityvend_secret_key`
+- `parityvend_secret_key_free`
+
+For this, run:
+
+```sh
+export PARITYVEND_SECRET_KEY='your-secret-key'
+export PARITYVEND_SECRET_KEY_FREE='your-free-key'
+```
+
+Or, for Windows:
+```cmd
+set "parityvend_secret_key=your-secret-key"
+set "parityvend_secret_key_free=your-free-key"
+```
+
+### Step 5: Make Changes
+
+Now you're ready to start making changes to the codebase! Follow best practices for Python development, write tests for new features or bug fixes, and ensure that all existing tests pass before submitting a pull request.
+
+## Submitting a Pull Request
+
+1. Fork the repository and create a new branch for your changes.
+2. Make your changes and commit them with descriptive commit messages.
+3. Push your changes to your forked repository.
+4. Create a pull request on the main repository, describing your changes and the motivation behind them.
+
+We'll review your pull request as soon as possible and provide feedback or merge it into the main codebase.
+
+## Code Style and Guidelines
+
+To ensure consistency and maintainability, please follow the established code style and guidelines for this project:
+
+* Use Ruff for code formatting and linting.
+* Follow the PEP 8 style guide for Python code.
+* Write clear and concise commit messages.
+* Keep the codebase clean and well-documented.
+* Ensure backward compatibility when making changes.
+
+## Other Ways to Contribute
+There are many ways to contribute to the project beyond writing code:
+
+* Report Bugs: If you discover a bug, create an issue on the project's GitHub repository with detailed steps to reproduce the issue.
+* Improve Documentation: Help us improve the project's documentation by suggesting edits, fixing typos, or writing additional documentation for new features.
+* Suggest New Features: Share your ideas on new functionality that you would want to see in the ParityVend Python API.
+
+Thank you for your interest in contributing to the ParityVend Python API! We appreciate your efforts to make this project better.