Skip to content

Fixing the pytest errors #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JAGADISHSUNILPEDNEKAR
Copy link
Contributor

Fix test failures by adding development mode installation instructions

This PR addresses issue #158 where a new contributor encountered multiple test failures when running the test suite. The primary issue was the lack of clear instructions for installing the package in development mode before running tests.

Changes made:

  1. Updated CONTRIBUTING.md to explicitly instruct contributors to run pip install -e . before running tests
  2. Added a new "Troubleshooting Test Failures" section that explains common test failure scenarios and how to address them

Why this fix is needed:

Without installing the package in development mode, the test modules cannot properly discover and import the local code, resulting in various import errors and API mismatch errors as seen in issue #158.

The test failures specifically showed:

  • Module import errors
  • Public Key class API mismatch errors
  • Transaction hex assertion errors

These are all symptoms of the tests not being able to correctly access the package modules, which is resolved by the development mode installation.

Testing:

I've verified this approach by:

  1. Running tests without development mode installation (reproducing the errors)
  2. Installing in development mode with pip install -e .
  3. Confirming that tests pass after proper installation

This documentation improvement should help new contributors avoid the same pitfalls when setting up their development environment.


@JAGADISHSUNILPEDNEKAR JAGADISHSUNILPEDNEKAR changed the title Fixing the module errors Fixing the purest errors Apr 29, 2025
@JAGADISHSUNILPEDNEKAR JAGADISHSUNILPEDNEKAR changed the title Fixing the purest errors Fixing the pytest errors Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant