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

districtgenerator is installed as 'classes' #6

Open
lensum opened this issue Aug 1, 2023 · 2 comments
Open

districtgenerator is installed as 'classes' #6

lensum opened this issue Aug 1, 2023 · 2 comments

Comments

@lensum
Copy link

lensum commented Aug 1, 2023

Please describe the bug
With the current repo structure, the command pip install -e districtgenerator installs the districtgenerator as package classes.

What are the steps to reproduce the bug?

  1. Follow the installation instructions of the package
  2. Try to import the districtgenerator with from districtgenerator.classes import *
  3. Read the error message
  4. Try to import the districtgenerator with from classes import *
  5. Marvel at the absence of an error message

What behavior did you expect?
It would be more intuitive to have the districtgenerator installed as districtgenerator. This could easily be achived by renaming the classes directory to districtgenerator (or moving the classes directory in a new directory called districtgenerator).

@c0nb4
Copy link

c0nb4 commented Jan 8, 2024

Generally speaking, I'm a bit unsure about the installation process. Where am i expected to clone the git folder into if I would like to use the Districtgenerator in a broader context. Additionally, no venv is mentioned.

@lensum
Copy link
Author

lensum commented Jan 8, 2024

@c0nb4 you can download/clone the repository anywhere you like on your system and use pip install <path> to install it into your venv/env. However, the bug described above applies, if you don't change anything in the repository.

jkriwet added a commit that referenced this issue Jun 12, 2024
jkriwet added a commit that referenced this issue Jun 12, 2024
jkriwet added a commit that referenced this issue Jun 12, 2024
jkriwet added a commit that referenced this issue Jun 12, 2024
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

When branches are created from issues, their pull requests are automatically linked.

2 participants