Skip to content

Commit 0482702

Browse files
committed
Update README
1 parent 17a75ea commit 0482702

File tree

1 file changed

+41
-18
lines changed

1 file changed

+41
-18
lines changed

README.md

Lines changed: 41 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,60 @@ This is a fork of [MySQLdb1](https://github.com/farcepest/MySQLdb1).
77
This project adds Python 3 support and bug fixes.
88
I hope this fork is merged back to MySQLdb1 like distribute was merged back to setuptools.
99

10-
## Install
1110

12-
### Prerequisites
11+
## Support
12+
13+
**Do Not use Github Issue Tracker to ask help. OSS Maintainer is not free tech support**
14+
15+
When your question looks relating to Python rather than MySQL:
16+
17+
* Python mailing list [python-list](https://mail.python.org/mailman/listinfo/python-list)
18+
* Slack [pythondev.slack.com](https://pyslackers.com/web/slack)
19+
20+
Or when you have question about MySQL:
21+
22+
* [MySQL Community on Slack](https://lefred.be/mysql-community-on-slack/)
23+
24+
25+
## Install
1326

14-
You may need to install the Python and MySQL development headers and libraries like so:
27+
### Windows
1528

16-
* `sudo apt-get install python-dev default-libmysqlclient-dev` # Debian / Ubuntu
17-
* `sudo yum install python-devel mysql-devel` # Red Hat / CentOS
18-
* `brew install mysql-client` # macOS (Homebrew)
29+
Building mysqlclient on Windows is very hard.
30+
But there are some binary wheels you can install easily.
1931

20-
On Windows, there are binary wheels you can install without MySQLConnector/C or MSVC.
32+
### macOS (Homebrew)
2133

22-
#### Note on Python 3 : if you are using python3 then you need to install python3-dev using the following command :
34+
Install MySQL and mysqlclient:
2335

24-
`sudo apt-get install python3-dev` # debian / Ubuntu
36+
```
37+
# Assume you are activating Python 3 venv
38+
$ brew install mysql
39+
$ pip install mysqlclient
40+
```
2541

26-
`sudo yum install python3-devel ` # Red Hat / CentOS
42+
If you don't want to install MySQL server, you can use mysql-client instead:
2743

28-
### Install from PyPI
44+
```
45+
# Assume you are activating Python 3 venv
46+
$ brew install mysql-client
47+
$ echo 'export PATH="/usr/local/opt/mysql-client/bin:$PATH"' >> ~/.bash_profile
48+
$ export PATH="/usr/local/opt/mysql-client/bin:$PATH"
49+
$ pip install mysqlclient
50+
```
2951

30-
`pip install mysqlclient`
52+
### Linux
3153

32-
NOTE: Wheels for Windows may be not released with source package. You should pin version
33-
in your `requirements.txt` to avoid trying to install newest source package.
54+
You may need to install the Python 3 and MySQL development headers and libraries like so:
3455

56+
* `$ sudo apt-get install python3-dev default-libmysqlclient-dev` # Debian / Ubuntu
57+
* `% sudo yum install python3-devel mysql-devel` # Red Hat / CentOS
3558

36-
### Install from source
59+
Then you can install mysqlclient via pip now:
3760

38-
1. Download source by `git clone` or [zipfile](https://github.com/PyMySQL/mysqlclient-python/archive/master.zip).
39-
2. Customize `site.cfg`
40-
3. `python setup.py install`
61+
```
62+
$ pip install mysqlclient
63+
```
4164

4265
### Documentation
4366

0 commit comments

Comments
 (0)