documentation (#37)

Author: xadupre

CHANGELOGS.rst

@@ -1,10 +1,15 @@
 
-===========
 Change Logs
 ===========
 
-current - 2021-10-26 - 0.00Mb
-=============================
+0.5.0
++++++
+
+* :pr:`33`: removes pyquickhelper dependency
+* :pr:`30`: fix compatiblity with pandas 2.0
+
+0.3.239
++++++++
 
 * :pr:`27`: Fixes json parser when input is a stream (2021-10-26)
 * :pr:`26`: Fixes bug while reading json (iterator failed to be created twice) (2021-10-26)
@@ -15,8 +20,8 @@ current - 2021-10-26 - 0.00Mb
 * :pr:`21`: Fixes grouping by nan values after update pandas to 1.3.0 (2021-07-10)
 * :pr:`17`: Implements method describe (2021-04-08)
 
-0.2.175 - 2020-08-06 - 0.03Mb
-=============================
+0.2.175
++++++++
 
 * :pr:`16`: Unit tests failing with pandas 1.1.0. (2020-08-06)
 * :pr:`15`: implements parameter lines, flatten for read_json (2018-11-21)

CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+# Code of Conduct
+
+We are a community based on openness, as well as friendly and didactic discussions.
+
+We aspire to treat everybody equally, and value their contributions.
+
+Decisions are made based on technical merit and consensus.
+
+Code is not the only way to help the project. Reviewing pull requests,
+answering questions to help others on mailing lists or issues, organizing and
+teaching tutorials, working on the website, improving the documentation, are
+all priceless contributions.
+
+We abide by the principles of openness, respect, and consideration of others of
+the Python Software Foundation: https://www.python.org/psf/codeofconduct/

README.rst

@@ -41,13 +41,13 @@ pandas-streaming: streaming API over pandas
     :target: https://github.com/sdpython/pandas_streaming/
     :alt: size
 
-**pandas_streaming**
-aims at processing big files with `pandas <http://pandas.pydata.org/>`_,
+`pandas-streaming <https://sdpython.github.io/doc/pandas-streaming/dev/>`_
+aims at processing big files with `pandas <https://pandas.pydata.org/>`_,
 too big to hold in memory, too small to be parallelized with a significant gain.
-The module replicates a subset of `pandas <http://pandas.pydata.org/>`_ API
+The module replicates a subset of *pandas* API
 and implements other functionalities for machine learning.
 
-::
+.. code-block:: python
 
     from pandas_streaming.df import StreamingDataFrame
     sdf = StreamingDataFrame.read_csv("filename", sep="\t", encoding="utf-8")
@@ -59,7 +59,7 @@ and implements other functionalities for machine learning.
 
 The module can also stream an existing dataframe.
 
-::
+.. code-block:: python
 
     import pandas
     df = pandas.DataFrame([dict(cf=0, cint=0, cstr="0"),
@@ -76,5 +76,3 @@ The module can also stream an existing dataframe.
 
 It contains other helpers to split datasets into
 train and test with some weird constraints.
-
-* `documentation <https://sdpython.github.io/doc/pandas-streaming/dev/>`_

_doc/index.rst

@@ -66,7 +66,4 @@ and implements other functionalities for machine learning.
     CHANGELOGS
     license
 
-**Links:**
-
-* `GitHub/pandas_streaming <https://github.com/sdpython/pandas_streaming/>`_
-* `documentation <https://sdpython.github.io/doc/pandas-streaming/dev/>`_
+Source are available at `sdpython/pandas_streaming <https://github.com/sdpython/pandas_streaming/>`_.