Skip to content

Commit

Permalink
Modify README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
prprprus committed Aug 8, 2019
1 parent cb81fe6 commit 748ed3b
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,16 @@ Table of content
- Maintain a minimum number of connection pools by default.
- If number of unuse connections less than zero, dynamically add connections to pool until current number of inuse connections equal maximum of pool.
- Release the idle connections in regular until number of unuse connections equal minimum of pool.
- Support autocommit mode.
- Support for ping check to get healthy connections.

## Requirements

- Python
- CPython : >= 3.4
- CPython : >= 3.4
- MySQL Server -- one of the following:
- MySQL >= 5.5
- MariaDB >= 5.5
- MySQL >= 5.5
- MariaDB >= 5.5
- PyMySQL: >= 0.9.2

## Installation
Expand Down Expand Up @@ -73,7 +75,7 @@ This example will print:
('Puffball', 'Diane', 'hamster', 'f', datetime.date(1999, 3, 30), None)
```

Support auto-commit mode, as following:
Support autocommit mode, as following:

```python
pool = Pool(host=HOST, port=PORT, user=USER, password=PASSWORD, db=DB, autocommit=True)
Expand All @@ -83,10 +85,10 @@ That's all.

## Roadmap

+ [x] Connection Pool
+ [x] Dynamically Create
+ [x] Dynamically Release
+ [ ] Monitor Web Interface
- [x] Connection Pool
- [x] Dynamically Create
- [x] Dynamically Release
- [ ] Monitor Web Interface

## Resources

Expand All @@ -99,6 +101,6 @@ PyMySQLPool is released under the MIT License. See LICENSE for more information.

## Contributing

Thank you for your interest in contribution of PyMySQLPool, your help and contribution is very valuable.
Thank you for your interest in contribution of PyMySQLPool, your help and contribution is very valuable.

You can submit issue and pull requests, please submit an issue before submitting pull requests.

0 comments on commit 748ed3b

Please sign in to comment.