134 lines
4.7 KiB
Plaintext
134 lines
4.7 KiB
Plaintext
Metadata-Version: 2.2
|
|
Name: mysqlclient
|
|
Version: 2.2.7
|
|
Summary: Python interface to MySQL
|
|
Author-email: Inada Naoki <songofacandy@gmail.com>
|
|
License: GNU General Public License v2 or later (GPLv2+)
|
|
Project-URL: Project, https://github.com/PyMySQL/mysqlclient
|
|
Project-URL: Documentation, https://mysqlclient.readthedocs.io/
|
|
Keywords: MySQL
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Environment :: Other Environment
|
|
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
|
|
Classifier: Operating System :: MacOS :: MacOS X
|
|
Classifier: Operating System :: Microsoft :: Windows :: Windows NT/2000
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Operating System :: POSIX
|
|
Classifier: Operating System :: POSIX :: Linux
|
|
Classifier: Operating System :: Unix
|
|
Classifier: Programming Language :: C
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Programming Language :: Python :: 3.12
|
|
Classifier: Programming Language :: Python :: 3.13
|
|
Classifier: Topic :: Database
|
|
Classifier: Topic :: Database :: Database Engines/Servers
|
|
Requires-Python: >=3.8
|
|
Description-Content-Type: text/markdown
|
|
License-File: LICENSE
|
|
|
|
# mysqlclient
|
|
|
|
This project is a fork of [MySQLdb1](https://github.com/farcepest/MySQLdb1).
|
|
This project adds Python 3 support and fixed many bugs.
|
|
|
|
* PyPI: https://pypi.org/project/mysqlclient/
|
|
* GitHub: https://github.com/PyMySQL/mysqlclient
|
|
|
|
|
|
## Support
|
|
|
|
**Do Not use Github Issue Tracker to ask help. OSS Maintainer is not free tech support**
|
|
|
|
When your question looks relating to Python rather than MySQL/MariaDB:
|
|
|
|
* Python mailing list [python-list](https://mail.python.org/mailman/listinfo/python-list)
|
|
* Slack [pythondev.slack.com](https://pyslackers.com/web/slack)
|
|
|
|
Or when you have question about MySQL/MariaDB:
|
|
|
|
* [MySQL Support](https://dev.mysql.com/support/)
|
|
* [Getting Help With MariaDB](https://mariadb.com/kb/en/getting-help-with-mariadb/)
|
|
|
|
|
|
## Install
|
|
|
|
### Windows
|
|
|
|
Building mysqlclient on Windows is very hard.
|
|
But there are some binary wheels you can install easily.
|
|
|
|
If binary wheels do not exist for your version of Python, it may be possible to
|
|
build from source, but if this does not work, **do not come asking for support.**
|
|
To build from source, download the
|
|
[MariaDB C Connector](https://mariadb.com/downloads/#connectors) and install
|
|
it. It must be installed in the default location
|
|
(usually "C:\Program Files\MariaDB\MariaDB Connector C" or
|
|
"C:\Program Files (x86)\MariaDB\MariaDB Connector C" for 32-bit). If you
|
|
build the connector yourself or install it in a different location, set the
|
|
environment variable `MYSQLCLIENT_CONNECTOR` before installing. Once you have
|
|
the connector installed and an appropriate version of Visual Studio for your
|
|
version of Python:
|
|
|
|
```
|
|
$ pip install mysqlclient
|
|
```
|
|
|
|
### macOS (Homebrew)
|
|
|
|
Install MySQL and mysqlclient:
|
|
|
|
```bash
|
|
$ # Assume you are activating Python 3 venv
|
|
$ brew install mysql pkg-config
|
|
$ pip install mysqlclient
|
|
```
|
|
|
|
If you don't want to install MySQL server, you can use mysql-client instead:
|
|
|
|
```bash
|
|
$ # Assume you are activating Python 3 venv
|
|
$ brew install mysql-client pkg-config
|
|
$ export PKG_CONFIG_PATH="$(brew --prefix)/opt/mysql-client/lib/pkgconfig"
|
|
$ pip install mysqlclient
|
|
```
|
|
|
|
### Linux
|
|
|
|
**Note that this is a basic step. I can not support complete step for build for all
|
|
environment. If you can see some error, you should fix it by yourself, or ask for
|
|
support in some user forum. Don't file a issue on the issue tracker.**
|
|
|
|
You may need to install the Python 3 and MySQL development headers and libraries like so:
|
|
|
|
* `$ sudo apt-get install python3-dev default-libmysqlclient-dev build-essential pkg-config` # Debian / Ubuntu
|
|
* `% sudo yum install python3-devel mysql-devel pkgconfig` # Red Hat / CentOS
|
|
|
|
Then you can install mysqlclient via pip now:
|
|
|
|
```
|
|
$ pip install mysqlclient
|
|
```
|
|
|
|
### Customize build (POSIX)
|
|
|
|
mysqlclient uses `pkg-config --cflags --ldflags mysqlclient` by default for finding
|
|
compiler/linker flags.
|
|
|
|
You can use `MYSQLCLIENT_CFLAGS` and `MYSQLCLIENT_LDFLAGS` environment
|
|
variables to customize compiler/linker options.
|
|
|
|
```bash
|
|
$ export MYSQLCLIENT_CFLAGS=`pkg-config mysqlclient --cflags`
|
|
$ export MYSQLCLIENT_LDFLAGS=`pkg-config mysqlclient --libs`
|
|
$ pip install mysqlclient
|
|
```
|
|
|
|
### Documentation
|
|
|
|
Documentation is hosted on [Read The Docs](https://mysqlclient.readthedocs.io/)
|