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

docs: Update the installation guide with anaconda in README.md, specified the Python version due to psycopg2 compatibility problem. #4460

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

Conversation

hxuaj
Copy link

@hxuaj hxuaj commented Jul 3, 2023

Update the installation guide with anaconda, specified the Python version due to psycopg2 problem mentioned in #3907.

PR fulfills these requirements

  • Commit message(s) and PR title follows the format [fix|feat|ci|chore|doc]: TICKET-ID: Short description of change made ex. fix: DEV-XXXX: Removed inconsistent code usage causing intermittent errors
  • Tests for the changes have been added/updated (for bug fixes/features)
  • Docs have been added/updated (for bug fixes/features)
  • Best efforts were made to ensure docs/code are concise and coherent (checked for spelling/grammatical errors, commented out code, debug logs etc.)
  • Self-reviewed and ran all changes on a local instance (for bug fixes/features)

Change has impacts in these area(s)

(check all that apply)

  • Product design
  • Backend (Database)
  • Backend (API)
  • Frontend

Describe the reason for change

(link to issue, supportive screenshots etc.)
By following the official installation guide with anaconda, I've encontered the same problem as in #3907. The root cause is that w/o specifying the python version, conda will install the latest python automatically, while LS supports up to Python 3.9 when installing by pip. So this pull request modifies the install guide with anaconda in README.md.

What does this fix?

(if this is a bug fix)

What is the new behavior?

(if this is a breaking or feature change)

What is the current behavior?

(if this is a breaking or feature change)
More concise install steps with anaconda in LS official installation guide.

What libraries were added/updated?

(list all with version changes)
README.md

Does this change affect performance?

(if so describe the impacts positive or negative)
No.

Does this change affect security?

(if so describe the impacts positive or negative)
No.

What alternative approaches were there?

(briefly list any if applicable)

What feature flags were used to cover this change?

(briefly list any if applicable)

Does this PR introduce a breaking change?

(check only one)

  • Yes, and covered entirely by feature flag(s)
  • Yes, and covered partially by feature flag(s)
  • No
  • Not sure (briefly explain the situation below)

What level of testing was included in the change?

(check all that apply)

  • e2e
  • integration
  • unit

Which logical domain(s) does this change affect?

(for bug fixes/features, be as precise as possible. ex. Authentication, Annotation History, Review Stream etc.)

Update the installation guide with anaconda, specified the Python version due to psycopg2 problem mentioned in HumanSignal#3907.
@netlify
Copy link

netlify bot commented Jul 3, 2023

👷 Deploy request for label-studio-docs-new-theme pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 5659a06

@netlify
Copy link

netlify bot commented Jul 3, 2023

👷 Deploy request for heartex-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 5659a06

@hxuaj hxuaj changed the title doc: README.md: Update the installation guide with anaconda, specified the Python version due to psycopg2 compatibility problem. docs: README.md: Update the installation guide with anaconda, specified the Python version due to psycopg2 compatibility problem. Jul 3, 2023
@hxuaj hxuaj changed the title docs: README.md: Update the installation guide with anaconda, specified the Python version due to psycopg2 compatibility problem. docs: Update the installation guide with anaconda in README.md, specified the Python version due to psycopg2 compatibility problem. Jul 3, 2023
@erinmikailstaples erinmikailstaples added community:reviewed Issue has been reviewed by the Label Studio Community Team. community:docs Documentation updated by the community labels Jul 24, 2023
@erinmikailstaples
Copy link
Contributor

Hey @hxuaj — thanks for the update here — setting it up for review and will get back to you ASAP! :)

Copy link

This PR is stale because it has been open 172 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@robot-ci-heartex
Copy link
Collaborator

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@sajarin sajarin added the Community Community Feature Requests, Open Issues, Bugs Reported, or Comments label Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community:docs Documentation updated by the community community:reviewed Issue has been reviewed by the Label Studio Community Team. Community Community Feature Requests, Open Issues, Bugs Reported, or Comments docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants