Skip to content

Commit 072a6cd

Browse files
committed
README: Add how to install/build
1 parent d431ac9 commit 072a6cd

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
mysqlclient
2-
===========
1+
# mysqlclient
32

43
[![Build Status](https://secure.travis-ci.org/PyMySQL/mysqlclient-python.png)](http://travis-ci.org/PyMySQL/mysqlclient-python)
54

@@ -8,11 +7,29 @@ This is a fork of [MySQLdb1](https://github.com/farcepest/MySQLdb1).
87
This project adds Python 3 support and bug fixes.
98
I hope this fork is merged back to MySQLdb1 like distribute was merged back to setuptools.
109

11-
Prerequisites for Installing
12-
----------------------------
10+
## Install
11+
12+
### Prerequisites
1313

1414
You may need to install the Python and MySQL development headers and libraries like so:
1515

1616
`sudo apt-get install python-dev libmysqlclient-dev` # Debian / Ubuntu
1717

1818
`sudo yum install python-devel mysql-devel` # Red Hat / CentOS
19+
20+
On Windows, there are binary wheel you can install without MySQLConnector/C or MSVC.
21+
22+
23+
### Install from PyPI
24+
25+
`pip install mysqlclient`
26+
27+
NOTE: Wheels for Windows may be not released with source package. You should pin version
28+
in your `requirements.txt` to avoid trying install source newest pacakge.
29+
30+
31+
### Install from source
32+
33+
1. Download source by `git clone` or [zipfile](https://github.com/PyMySQL/mysqlclient-python/archive/master.zip).
34+
2. Customize `site.cfg`
35+
3. `python setup.py install`

0 commit comments

Comments
 (0)