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

In JIRA: Update Schematic Setup docs with current Schematic version #532

Open
1 of 3 tasks
tschaffter opened this issue May 15, 2023 · 1 comment
Open
1 of 3 tasks
Labels
bug Something isn't working

Comments

@tschaffter
Copy link
Member

Describe the bug

In the README, the docs says to run pip install dist/schematicpy-1.0.0-py3-none-any.whl, which fails.

To Reproduce
Steps to reproduce the behavior:

(.venv) vscode@a348f83e716d:/workspaces/btc-data-models/tmp/data_curator/schematic$ poetry build
Building schematicpy (22.3.2)
  - Building sdist
  - Built schematicpy-22.3.2.tar.gz
  - Building wheel
  - Built schematicpy-22.3.2-py3-none-any.whl
(.venv) vscode@a348f83e716d:/workspaces/btc-data-models/tmp/data_curator/schematic$ pip install dist/schematicpy-1.0.0-py3-none-any.whl
WARNING: Requirement 'dist/schematicpy-1.0.0-py3-none-any.whl' looks like a filename, but the file does not exist
Processing ./dist/schematicpy-1.0.0-py3-none-any.whl
ERROR: Could not install packages due to an EnvironmentError: [Errno 2] No such file or directory: '/workspaces/btc-data-models/tmp/data_curator/schematic/dist/schematicpy-1.0.0-py3-none-any.whl'

The error occurs because of the mismatched version of Schematic built and the version that the docs ask to install.

Expected behavior

The command should be:

pip install dist/schematicpy-22.3.2-py3-none-any.whl

Note Consider making the docs robust to Schematic version changes.

Priority (select one)

  • Minor ⬇️
  • Major 📢
  • Critical 🆘

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (if applicable, please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

@tschaffter tschaffter added the bug Something isn't working label May 15, 2023
@MiekoHash
Copy link

@MiekoHash MiekoHash changed the title Update Schematic Setup docs with current Schematic version In JIRA: Update Schematic Setup docs with current Schematic version May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants