encypher-ai 1.0.0__tar.gz

encypher_ai-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,86 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in the EncypherAI 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:** conduct@encypherai.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.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.

encypher_ai-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,139 @@
+# Contributing to EncypherAI Core
+
+Thank you for your interest in contributing to EncypherAI Core! This document provides guidelines and instructions for contributing to this project.
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others.
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please create an issue with the following information:
+
+1. A clear, descriptive title
+2. A detailed description of the issue
+3. Steps to reproduce the bug
+4. Expected behavior
+5. Actual behavior
+6. Any relevant logs or screenshots
+7. Your environment (OS, Python version, package version)
+
+### Suggesting Enhancements
+
+We welcome suggestions for enhancements! Please create an issue with:
+
+1. A clear, descriptive title
+2. A detailed description of the enhancement
+3. The motivation for the enhancement
+4. Any examples or use cases
+
+### Pull Requests
+
+1. Fork the repository
+2. Create a new branch for your feature or bugfix
+3. Make your changes
+4. Add or update tests as necessary
+5. Update documentation as necessary
+6. Submit a pull request
+
+#### Pull Request Guidelines
+
+- Follow the existing code style
+- Include tests for new features or bug fixes
+- Update documentation for any changes
+- Keep pull requests focused on a single change
+- Reference any related issues in your PR description
+
+## Development Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/yourusername/encypher-ai.git
+   cd encypher-ai
+   ```
+
+2. Create a virtual environment:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. Install development dependencies:
+   ```bash
+   uv pip install -e ".[dev]"
+   ```
+
+4. Set up pre-commit hooks:
+   ```bash
+   pre-commit install
+   ```
+
+5. Run tests:
+   ```bash
+   pytest
+   ```
+
+## Code Style
+
+We follow PEP 8 style guidelines with Black as our code formatter. All code must pass Black formatting checks before being merged.
+
+### Automated Formatting with Pre-commit
+
+We use pre-commit hooks to automatically format code and check for issues before committing. The hooks will:
+
+1. Format code with Black (including Jupyter notebooks)
+2. Sort imports with isort
+3. Check for common issues with flake8 and ruff
+4. Perform type checking with mypy
+
+After installing the pre-commit hooks (step 4 in Development Setup), they will run automatically on each commit.
+
+### Manual Code Formatting
+
+You can also run the formatting tools manually:
+
+```bash
+# Format all Python files
+black encypher
+
+# Format Python files including Jupyter notebooks
+black --jupyter encypher
+
+# Sort imports
+isort encypher
+
+# Run all pre-commit hooks on all files
+pre-commit run --all-files
+```
+
+## Testing
+
+Please write tests for any new features or bug fixes. We use pytest for testing.
+
+```bash
+# Run all tests
+pytest
+
+# Run tests with coverage
+pytest --cov=encypher
+```
+
+## Documentation
+
+Please update documentation for any changes. We use docstrings for function and class documentation.
+
+## Versioning
+
+We use [Semantic Versioning](https://semver.org/). Please ensure that your changes are compatible with the versioning scheme.
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the project's license.
+
+## Questions?
+
+If you have any questions, please feel free to create an issue or contact the maintainers.
+
+Thank you for your contributions!