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

[FEATURE] Update README to reflect Python requirement #148

Open
slavakurilyak opened this issue Jan 27, 2024 · 1 comment
Open

[FEATURE] Update README to reflect Python requirement #148

slavakurilyak opened this issue Jan 27, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@slavakurilyak
Copy link

Is your feature request related to a problem? Please describe.

Problem Description:
There is a compatibility issue arising from the project's Python environment setup. The project's dependencies, particularly numpy, require a specific range of Python versions. However, these specific requirements are not clearly stated in the project's documentation, leading to potential setup difficulties and compatibility issues for contributors.

Describe the solution you'd like

Proposed Solution:
I recommend updating the README with detailed instructions on setting up a Python environment that aligns with the project's dependencies. Specifically, the README should state the recommended Python version as ^3.10, <3.13 to ensure compatibility with numpy. The updated instructions should include:

  1. A clear recommendation for the Python version: ^3.10, <3.13.
  2. Detailed steps for creating and activating a virtual environment using tools like venv or pyenv.
  3. Instructions to verify that the correct Python version is being used within the virtual environment.

This update will help contributors set up their development environments more efficiently and reduce the risk of compatibility issues.

Describe alternatives you've considered

Alternatives Considered:

  1. Keeping the setup process as is, but this may continue to lead to inconsistencies and issues among contributors.
  2. Implementing containerization with tools like Docker, although this could add complexity and may not be necessary for all contributors.

Additional context

Additional Context:

  • Providing explicit environment setup instructions can significantly improve the contributor experience, especially for those who are new to the project.
  • Clear documentation in the README regarding the Python version requirement will minimize setup-related confusion and streamline the initial development process.
@slavakurilyak slavakurilyak added the enhancement New feature or request label Jan 27, 2024
@jmar5439
Copy link

yes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants