Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[BUG] Installation instructions are incomplete #574

Open
Labels
bugSomething isn't working documentationImprovements or additions to documentation good first issueGood for newcomers
@AdrianDAlessandro

Description

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

When following the documentation, the requirements fail to install as described. Specifically, the mysqlclient dependency fails to install. The installation instructions for that package explain that MySQL needs to installed and available in the system before the python package is installed.

This is not stated in the README

Expected Behavior

The installations instructions in the README should include adequate details.

Steps To Reproduce

As described in the readme, in a virtual environment run:

×ばつ Getting requirements to build wheel did not run successfully. │ exit code: 1 ╰─> See above for output. note: This error originates from a subprocess, and is likely not a problem with pip.">
$ pip install -r dev-requirements.txt
Collecting...
...
 Exception: Can not find valid pkg-config name.
 Specify MYSQLCLIENT_CFLAGS and MYSQLCLIENT_LDFLAGS env vars manually
 [end of output]
 
 note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-e×ばつ Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> See above for output.
note: This error originates from a subprocess, and is likely not a problem with pip.

Environment

- OS: macOS 15.7.3
- Python version: 3.13.1
- Software versions: `main` branch

Anything else?

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working documentationImprovements or additions to documentation good first issueGood for newcomers

    Type

    No type

    Projects

    Status

    🔖 Ready

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      AltStyle によって変換されたページ (->オリジナル) /