diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3f8e7d4 --- /dev/null +++ b/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 +GitHub Issues. +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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8ee3b79 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing to ALTCHA + +We appreciate your contributions! To ensure a smooth and transparent collaboration, we've outlined the various ways you can contribute to ALTCHA: + +- **Reporting a Bug** +- **Discussing the Current State of the Code** +- **Submitting a Fix** +- **Proposing New Features** +- **Becoming a Maintainer** + +## Development with GitHub + +ALTCHA is hosted on GitHub, where you can find the codebase, track issues, and submit pull requests. Please familiarize yourself with GitHub for effective collaboration. + +## Project Technology: Svelte + +ALTCHA utilizes [Svelte](https://svelte.dev) for its Web Component widget. Refer to Svelte's documentation to set up your development environment. + +## Licensing Information + +Any contributions you make will be subjected to the project's MIT software license. By submitting code changes, you agree to license your contributions under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the entire project. If you have any concerns regarding licensing, feel free to reach out to the maintainers. + +## Reporting Bugs Using GitHub's [Issues](https://github.com/altcha-org/altcha-lib-py/issues) + +We track public bugs using GitHub issues. Reporting a bug is easy: simply [open a new issue](https://github.com/altcha-org/altcha-lib-py/issues). Provide detailed information for effective bug resolution. + +## Writing Effective Bug Reports + +Good bug reports include: + +- A quick summary and background of the issue +- Steps to reproduce the problem + - Be specific! + - Include sample code if possible +- Expected vs. actual outcomes +- Additional notes, such as your hypotheses or unsuccessful attempts to resolve the issue + +## License Agreement + +By contributing to ALTCHA, you agree that your contributions will be licensed under the project's MIT License. If you have any questions or concerns, please reach out to the maintainers. diff --git a/altcha/altcha.py b/altcha/altcha.py index 741e78d..b0dab21 100644 --- a/altcha/altcha.py +++ b/altcha/altcha.py @@ -67,7 +67,7 @@ class Challenge: def __init__(self, algorithm, challenge, max_number, salt, signature): self.algorithm = algorithm self.challenge = challenge - self.max_number = max_number + self.maxnumber = max_number self.salt = salt self.signature = signature @@ -367,7 +367,7 @@ def verify_fields_hash(form_data, fields, fields_hash, algorithm): algorithm (str): Hashing algorithm to use (e.g., 'SHA-1', 'SHA-256', 'SHA-512'). Returns: - tuple: A tuple (bool) where the first element is True if the hash matches. + bool: True if the computed hash matches the expected hash, False otherwise. """ lines = [form_data.get(field, "") for field in fields] joined_data = "\n".join(lines) @@ -449,8 +449,9 @@ def solve_challenge(challenge, salt, algorithm, max_number, start): start (int): Starting number to try. Returns: - tuple: A tuple (Solution or None) where the first element is a Solution object if the challenge - is solved. + Solution: A Solution object containing the number that solves the challenge and the time taken, + if the challenge is solved. + None: If no solution is found within the range. """ if not algorithm: algorithm = "SHA-256" diff --git a/setup.py b/setup.py index f99bd5c..ad38f68 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ setup( name='altcha', - version='0.1.2', + version='0.1.3', description='A library for creating and verifying challenges for ALTCHA.', long_description=open('README.md').read(), long_description_content_type='text/markdown', diff --git a/tests/test_altcha.py b/tests/test_altcha.py index 10f9105..edd74c9 100644 --- a/tests/test_altcha.py +++ b/tests/test_altcha.py @@ -193,7 +193,7 @@ def test_solve_challenge(self): challenge.challenge, challenge.salt, challenge.algorithm, - challenge.max_number, + challenge.maxnumber, 0, )