helpscout-mailbox 1.0.0__tar.gz

helpscout_mailbox-1.0.0/.gitignore

@@ -0,0 +1,62 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pytype/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# OMC state
+.omc/
+
+# Documentation
+docs/
+site/
+
+# Distribution
+*.tar.gz
+*.whl

helpscout_mailbox-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,57 @@
+# 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:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior:
+
+- The use of sexualized language or imagery and unwelcome sexual attention
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information without explicit permission
+- Other conduct which could reasonably be considered inappropriate
+
+## Enforcement Responsibilities
+
+Project maintainers 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.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the project maintainers at devops@connectify.com. All complaints
+will be reviewed and investigated promptly and fairly.
+
+All project maintainers are obligated to respect the privacy and security of
+the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

helpscout_mailbox-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to helpscout-mailbox
+
+Thank you for your interest in contributing to helpscout-mailbox!
+
+## Code of Conduct
+
+This project adheres to a Code of Conduct that all contributors are expected to follow. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
+
+## How to Contribute
+
+### Reporting Issues
+
+- Check existing [issues](https://github.com/Connectify/helpscout-mailbox/issues) first
+- Provide reproduction steps, expected vs actual behavior
+- Include Python version, library version, and environment details
+
+### Submitting Pull Requests
+
+1. **Fork** the repository
+2. **Create a feature branch**: `git checkout -b feature/your-feature-name`
+3. **Make your changes**:
+   - Follow existing code style (Black, isort, flake8)
+   - Add tests for new functionality
+   - Update docstrings (NumPy style)
+   - Run `pre-commit run --all-files` before committing
+4. **Commit**: Use clear, descriptive commit messages
+5. **Push**: `git push origin feature/your-feature-name`
+6. **Open a Pull Request** with:
+   - Description of what changed and why
+   - Link to related issues
+   - Test results
+
+### Development Setup
+
+```bash
+# Clone your fork
+git clone https://github.com/YOUR-USERNAME/helpscout-mailbox.git
+cd helpscout-mailbox
+
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Install pre-commit hooks
+pre-commit install
+
+# Run tests
+pytest
+
+# Run all linters
+pre-commit run --all-files
+```
+
+### Testing
+
+- Add tests for all new features and bug fixes
+- Maintain or improve code coverage
+- Use `responses` library to mock HTTP calls
+- Run `pytest` to verify tests pass
+
+```bash
+# Run tests with coverage
+pytest --cov=helpscout_mailbox --cov-report=term-missing
+
+# Run specific test
+pytest tests/test_client.py::test_parse_created_at
+```
+
+### Code Style
+
+This project uses:
+- **Black** (line length 120) for formatting
+- **isort** for import sorting
+- **flake8** for linting
+- **mypy** for type checking (strict mode)
+- **bandit** for security checks
+
+Pre-commit hooks enforce these automatically.
+
+### Docstring Style
+
+Use NumPy-style docstrings:
+
+```python
+def example_function(param1: str, param2: int) -> bool:
+    """
+    Brief description of what the function does.
+
+    Longer description if needed, explaining behavior,
+    edge cases, or important details.
+
+    Parameters
+    ----------
+    param1 : str
+        Description of param1.
+    param2 : int
+        Description of param2.
+
+    Returns
+    -------
+    bool
+        Description of return value.
+
+    Raises
+    ------
+    ValueError
+        When param2 is negative.
+    """
+    pass
+```
+
+### Documentation
+
+- Update README.md for user-facing changes
+- Docstrings generate API docs automatically via pdoc
+- Build docs locally: `pdoc -o docs/ helpscout_mailbox`
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the GPL-3.0-or-later license.
+
+No Contributor License Agreement (CLA) is required.
+
+## Questions?
+
+Open an issue or start a discussion in [GitHub Issues](https://github.com/Connectify/helpscout-mailbox/issues).