Skip to content
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

Move/rename "tests" module #374

Closed
MaxKh opened this issue Aug 23, 2022 · 6 comments
Closed

Move/rename "tests" module #374

MaxKh opened this issue Aug 23, 2022 · 6 comments
Labels
new-feature-request Feature request that needs triage Team Scytale

Comments

@MaxKh
Copy link

MaxKh commented Aug 23, 2022

Problem

The py-algorand-sdk's "tests" module may conflict with a local one. I believe that "tests" is a quite popular name for a projects' UTs.

Solution

Please rename "tests", move into "algosdk" or ship "tests" as "extras" which allows to exclude this module from installation.

Dependencies

Urgency

@MaxKh MaxKh added the new-feature-request Feature request that needs triage label Aug 23, 2022
@winder
Copy link
Contributor

winder commented Sep 29, 2022

@tzaffi are you familiar with this issue?

@tzaffi
Copy link
Contributor

tzaffi commented Sep 29, 2022

I was involved in reviewing #351 which renamed the test directory to tests. As a starting point to help investigate a solution, @MaxKh - could you provide a reproducible method to observe the conflict? For example, a github repo with instructions for building but which gets stuck because of this naming issue.

@tzaffi
Copy link
Contributor

tzaffi commented Sep 29, 2022

Also, @jasonpaulos might have some more familiarity with the history of why we chose test for the SDK's testing directory starting out.

@jasonpaulos
Copy link
Contributor

test/tests is a pretty common convention for testing directories, and I think it's in our best interests to keep the directory structure like this. If implemented properly, our choice of internal directory names should not cause any problems for consumers of this library.

Perhaps the issue is that our tests folder is unintentionally being picked by setuptools as a package we wish to export? We do ask setuptools to automatically find all packages:

packages=setuptools.find_packages(),

If this is the case, there are alternatives we could consider, but we first need a reproducible example to be sure.

@michaeldiamant
Copy link
Contributor

FYI - Opened #408 to track changing setup.py.

@algochoi
Copy link
Contributor

We no longer ship tests as a part of the py-algorand-sdk installation, as of #428 . Let us know if this resolves the issue!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature-request Feature request that needs triage Team Scytale
Projects
None yet
Development

No branches or pull requests

7 participants