Skip to content

Commit 1e8d64b

Browse files
julien-duponchellejulien-duponchelle
committed
Complete documentation
1 parent 6ef4d86 commit 1e8d64b

File tree

7 files changed

+109
-12
lines changed

7 files changed

+109
-12
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ Other contributors:
288288

289289
Licence
290290
=======
291-
Copyright 2012 Julien Duponchelle
291+
Copyright 2012-2014 Julien Duponchelle
292292

293293
Licensed under the Apache License, Version 2.0 (the "License");
294294
you may not use this file except in compliance with the License.

‎docs/changelog.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
##########
2+
Changelog
3+
##########
4+
5+
0.3 07/07/2014
6+
===============
7+
* use NotImplementedEvent instead of raising an Exception
8+
* Python 3 fix
9+
* Add 2006 to Mysql expected error codes
10+
11+
0.2 13/10/2013
12+
===============
13+
* pymysql 0.6 support
14+
* fix smallint24
15+
* fix new decimal support
16+
* TINYINT(1) to bool mapping
17+
* change names of events to V2 from default
18+
* Fix broken "dates" - zero years..
19+
* add support for NULL_EVENT, INTVAR_EVENT and GTID_LOG_EVENT
20+
* Skip invalid packets
21+
* Display log pos inside events dump
22+
* Handle utf8 name for queries
23+
24+
0.1 01/05/2013
25+
===============
26+
First public version

‎docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@
4141

4242
# General information about the project.
4343
project = u'Python MySQL Replication'
44-
copyright = u'2012, Julien Duponchelle'
44+
copyright = u'2012-2014, Julien Duponchelle'
4545

4646
# The version info for the project you're documenting, acts as replacement for
4747
# |version| and |release|, also used in various other places throughout the
4848
# built documents.
4949
#
5050
# The short X.Y version.
51-
version = '0.1'
51+
version = '0.3'
5252
# The full version, including alpha/beta/rc tags.
53-
release = '0.1'
53+
release = '0.3'
5454

5555
# The language for content autogenerated by Sphinx. Refer to documentation
5656
# for a list of supported languages.

‎docs/developement.rst

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
#############
2+
Developement
3+
#############
4+
5+
Contributions
6+
=============
7+
8+
You can report issues and contribute to the project on: https://github.com/noplay/python-mysql-replication
9+
10+
The standard way to contribute code to the project is to fork the Github
11+
project and open a pull request with your changes:
12+
https://github.com/noplay/python-mysql-replication
13+
14+
Don't hesitate to open an issue with what you want to changes if
15+
you want to discuss about it before coding.
16+
17+
18+
Tests
19+
======
20+
21+
*pymysqlreplication/tests/* contains the test suite. The test suite
22+
use the standard *unittest* Python module.
23+
24+
**Be carefull** tests will reset the binary log of your MySQL server.
25+
26+
Make sure you have the following configuration set in your mysql config file (usually my.cnf on development env):
27+
28+
::
29+
30+
log-bin=mysql-bin
31+
server-id=1
32+
binlog-format = row #Very important if you want to receive write, update and delete row events
33+
34+
35+
To run tests:
36+
37+
::
38+
39+
python setup.py test
40+
41+
42+
Build the documentation
43+
========================
44+
45+
The documentation is available in docs folder. You can
46+
build it using Sphinx:
47+
48+
::
49+
50+
cd docs
51+
pip install sphinx
52+
make html
53+

‎docs/index.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,34 @@
55
66
Welcome to Python MySQL Replication's documentation!
77
====================================================
8-
Pure Python Implementation of MySQL replication protocol build on top of PyMYSQL
98

10-
Contents:
9+
Pure Python Implementation of MySQL replication protocol build on top of PyMYSQL. This allow you to receive event like insert, update, delete with their datas and raw SQL queries.
10+
11+
Use cases
12+
===========
13+
14+
* MySQL to NoSQL database replication
15+
* MySQL to search engine replication
16+
* Invalidate cache when something change in database
17+
* Audit
18+
* Real time analytics
19+
20+
21+
Contents
22+
=========
1123

1224
.. toctree::
1325
:maxdepth: 2
1426

27+
installation
28+
changelog
1529
binlogstream
1630
events
1731
examples
1832
support
33+
developement
1934
licence
2035

21-
Contributing
22-
============
23-
You can report issues and contribute to the project on:
24-
https://github.com/noplay/python-mysql-replication
25-
2636
Indices and tables
2737
==================
2838

‎docs/installation.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#############
2+
Installation
3+
#############
4+
5+
Python MySQL Replication is available on PyPi.
6+
You can install it with:
7+
8+
:command:`pip install mysql-replication`

‎docs/licence.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Licence
33
#######
44

5-
Copyright 2012 Julien Duponchelle
5+
Copyright 2012-2014 Julien Duponchelle
66

77
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
88

0 commit comments

Comments
 (0)