Merge pull request #7 from VanOord/prepare-0.0.4

Prepare release 0.0.4
VanOord · Oct 19, 2021 · b0c8d6a · b0c8d6a
2 parents 085d48b + 69a5df1
commit b0c8d6a
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 17 deletions.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -1,3 +1,4 @@
 # Contributors
 
 * Thijs Damsma <tdamsma@gmail.com>
+* Gerben de Boer <gerben.deboer@vanoord.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,3 +3,8 @@
 ## Version 0.0.1 (development)
 
 - Initial release
+
+## Version 0.0.4 (development)
+
+- Add support for handling timezones
+- Expand documentation
diff --git a/docs/conf.py b/docs/conf.py
@@ -8,8 +8,8 @@
 # serve to show the default.
 
 import os
-import sys
 import shutil
+import sys
 
 # -- Path setup --------------------------------------------------------------
 

diff --git a/docs/index.md b/docs/index.md
@@ -1,17 +1,28 @@
 # pandas-xlsx-tables
 
- This separate package provides utility functions to read and write Excel Tables from/to Pandas DataFrames.
+ Even though you might not like it, Excel isn't going anywhere. And Excel with tables is [a lot better than without](https://www.ecosia.org/search?q=advantages+of+excel+tables).
 
+Strangely Pandas does not support reading from and writing to excel tables out of the box, and due to the complexity of Pandas this is [not easily added](https://github.com/pandas-dev/pandas/issues/24862) (though having this built into Pandas would be the prefered solution). This separate package is thus a separate companion to Pandas, with utility functions to read and write Excel Tables from and to Pandas DataFrames.
 
-## Note
+!["Excel screenshot](https://raw.githubusercontent.com/VanOord/pandas-xlsx-tables/master/docs/_static/xlsx_table.png)
 
-> This is the main page of your project's [Sphinx] documentation. It is
-> formatted in [Markdown]. Add additional pages by creating md-files in
-> `docs` or rst-files (formated in [reStructuredText]) and adding links to
-> them in the `Contents` section below.
->
-> Please check [Sphinx], [recommonmark] and [autostructify] for more information
-> about how to document your project and how to configure your preferences.
+```python
+>>> from pandas_xlsx_tables import xlsx_table_to_df
+>>> df = xlsx_table_to_df("my_file.xlsx", "Table1")
+>>> df
+     col1 col2
+Row
+0       1    a
+1       2    b
+```
+And the reverse process:
+
+```python
+>>> from pandas_xlsx_tables import df_to_xlsx_table
+>>> df_to_xlsx_table(df, "my_table", header_orientation="diagonal", index=False)
+```
+
+!["Excel screenshot](https://raw.githubusercontent.com/VanOord/pandas-xlsx-tables/master/docs/_static/xlsx_table_2.png)
 
 
 ## Contents
@@ -30,9 +41,3 @@
 * :ref:`modindex`
 * :ref:`search`
 ```
-
-[Sphinx]: http://www.sphinx-doc.org/
-[Markdown]: https://daringfireball.net/projects/markdown/
-[reStructuredText]: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
-[recommonmark]: https://recommonmark.readthedocs.io/en/latest
-[autostructify]: https://recommonmark.readthedocs.io/en/latest/auto_structify.html
diff --git a/setup.cfg b/setup.cfg
@@ -13,7 +13,7 @@ long_description_content_type = text/markdown; charset=UTF-8; variant=GFM
 url = https://github.com/VanOord/pandas-xlsx-tables
 # Add here related links, for example:
 project_urls =
-    Documentation = https://github.com/VanOord/pandas-xlsx-tables
+    Documentation = https://pandas-xlsx-tables.readthedocs.io/en/latest/
     Source = https://github.com/VanOord/pandas-xlsx-tables
     Changelog = https://github.com/VanOord/pandas-xlsx-tables/blob/master/CHANGELOG.md
     Tracker = https://github.com/VanOord/pandas-xlsx-tables/issues